Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
scim

Provision and invite a SCIM user

Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "Reinstating a former member of your organization."

post/scim/v2/organizations/{org}/Users

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Request body

userNamestring required

Configured by the admin. Could be an email, login, or username

displayNamestring

The name of the user, suitable for display to end-users

schemasstring[]
externalIdstring
groupsstring[]
activeboolean

Example request

{
  "userName": "someone@example.com",
  "displayName": "Jon Doe",
  "name": {
    "givenName": "Jane",
    "familyName": "User"
  },
  "emails": [
    {
      "value": "someone@example.com",
      "primary": true
    },
    {
      "value": "another@example.com",
      "primary": false
    }
  ]
}

Response

Response