Users

Invite a user to join the platform

Changed on

Required scope - write_user. Assigning a privileged role (e.g. super_admin) additionally requires the caller to hold the root scope.

post/api/v1/users/invitations

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth2/v1/token

Request body

emailstring email required

The email address to invite

firstNamestring

Optional first name

lastNamestring

Optional last name

localestring

Locale for the invitation email

orgSlugstring

Organization slug to assign the user to

rolesstring[]

Roles to assign to the invited user

signinUrlstring

URL to redirect the user to after accepting the invitation

Response

Example response

{
  "user": {
    "attributes": {
      "attribute name 1": "value for attribute name 1",
      "attribute name 2": "value for attribute name 2"
    }
  }
}

Changes