v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-03-2585861610.1 MB

enterprise-admin

Set SCIM information for a provisioned enterprise user

Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.

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.

Warning: Setting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

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. You can also substitute this value with the enterprise id.

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