Sign in

v56

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

Update a provisioned organization membership

Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

You must at least provide the required values for the user: userName, name, and emails.

[!WARNING] Setting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

put/scim/v2/organizations/{org}/Users/{scim_user_id}

Path parameters

orgstring required

The organization name. The name is not case sensitive.

scim_user_idstring required

The unique identifier of the SCIM user.

Request body

schemasstring[]
displayNamestring

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

externalIdstring
groupsstring[]
activeboolean
userNamestring required

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

Example request

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

Response

Response