API ReferenceManagementTenantsSCIM
PUT
/scim/v2/Users/{userId}

Update an existing SCIM user, using a valid access key.

This endpoint allows administrators to update an existing SCIM user. Through this API endpoint, administrators can update the displayName, phoneNumbers, emails, and if the user is active.

The response includes the user's object, which includes details about the users including their email, phone, username, name, etc.

It is important to note the bearer token for SCIM API endpoints. The format is ProjectId:AccessKey the access key must be associated with the applicable tenant and associated with the tenant admin role.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:AccessKey\>

Try it

/scim/v2/Users/{userId}

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Access Key > as bearer

In: header

Request Body

userIdstring

displayNamestring

The following values are manipulated by the marshaler in httpgateway/marshaler.go in case of changing or adding new ones, need to edit the marshaler as well

emailsarray<object>

activeboolean

nameobject

userNamestring

attributesobject

Path Parameters

userId
Required
string

Status codeDescription
200OK
curl -X PUT "https://api.descope.com/scim/v2/Users/{userId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:AccessKey>" \
  -d '{
  "userId": "string",
  "displayName": "string",
  "emails": [
    {
      "value": "string",
      "primary": true,
      "type": "string"
    }
  ],
  "active": true,
  "name": {
    "givenName": "string",
    "familyName": "string",
    "middleName": "string"
  },
  "userName": "string",
  "attributes": {}
}'

{
  "user": {
    "schemas": [
      "string"
    ],
    "id": "string",
    "userName": "string",
    "meta": {
      "created": {},
      "location": "string",
      "lastModified": {},
      "resourceType": "string"
    },
    "emails": [
      {
        "value": "string",
        "primary": true,
        "type": "string"
      }
    ],
    "name": {
      "givenName": "string",
      "familyName": "string",
      "middleName": "string"
    },
    "active": true,
    "displayName": "string",
    "detail": "string",
    "attributes": {}
  }
}

Was this helpful?

Previous

Load SCIM User

Next

Delete SCIM User