v56

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

enterprise-admin

Set SCIM information for a provisioned enterprise user

Replaces an existing provisioned user's information.

You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the Update an attribute for a SCIM user endpoint.

[!WARNING] Setting active: false will suspend a user. As a result, their handle and primary email address will be obfuscated.

{
 "schemas": [
   "urn:ietf:params:scim:schemas:core:2.0:User"
 ],
 "externalId": "E012345",
 "active": false,
 "userName": "E012345",
 "name": {
   "familyName": "Octocat",
   "givenName": "Mona",
   "middleName": "Lisa"
 },
 "displayName": "Mona Lisa",
 "emails": [
   {
     "value": "mlisa@example.com",
     "type": "work",
     "primary": true
   }
 ],
 "roles": [
   {
     "value": "User"
   }
 ]
}

put/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

Path parameters

scim_user_idstring required

The unique identifier of the SCIM user.

enterprisestring required

The slug version of the enterprise name.

Request body

schemasstring[] required

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstring required

A unique identifier for the resource as defined by the provisioning client.

activeboolean required

Whether the user active in the IdP.

userNamestring required

The username for the user.

displayNamestring required

A human-readable name for the user.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "E012345",
  "active": true,
  "userName": "E012345",
  "name": {
    "formatted": "Ms. Mona Lisa Octocat",
    "familyName": "Octocat",
    "givenName": "Mona",
    "middleName": "Lisa"
  },
  "displayName": "Mona Lisa",
  "emails": [
    {
      "value": "mlisa@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "roles": [
    {
      "value": "user"
    }
  ]
}

Response

User was updated