Permalink: https://doc.oneportal.fi/x/r4IW

It is possible to invite new user accounts via email. The API end-points to execute this is /api/rest/v1/invite/user. Documentation for it is available on the OpenAPI documentation at /apidoc and /api/rest/v1/openapi.json.

Each email invite may be sent to multiple email addresses (invitees). In addition to email addresses, the invite email contains several attributes, which are all optional:

• email subject,
  
• email body text (may contain HTML, plain text, or even both), and
  
• locale information (default is "en" for English).

onePortal specific details include (both optional again):

• Namespace code where new user accounts will be added. This information is optional. New user accounts are added by default to the namespace where inviter account is.
• Group names where the invitees are added as a member when the new account is created.
  

Each invite is sent out as an individual email to allow for easier tracking. This means, if you are inviting thousands of new users, the sending may take a while.

In addition to sending out invites, it is possible to query current state of invites sent out. Also, resending an invite is possible, and canceling a current open invite.

If you try to send out very "exotic" invites, please verify them carefully before sending out them en-massé. Nowadays it is possible to end up as a spammer very easily, and then you have a problem. This is why we recommend using user invites sparingly, and mostly invite company employees, and the like.