Update SCIM User | API Reference | Descope Documentation

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.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:AccessKey\>

Authorization

`Authorization`
Required
Bearer <token>

< Project ID >:< Access Key > as bearer

In: header

Request Body

`userId`string

`displayName`string

`emails`array<object>

`active`boolean

`name`object

`userName`string

`title`string

Path Parameters

`userId`
Required
string

Status code	Description
`200`	OK

curl -X PUT "https://api.descope.com/scim/v2/Users/string" \
  -d '{
  "userId": "string",
  "displayName": "string",
  "emails": [
    {
      "value": "string",
      "primary": true,
      "type": "string"
    }
  ],
  "active": true,
  "name": {
    "givenName": "string",
    "familyName": "string",
    "middleName": "string"
  },
  "userName": "string",
  "title": "string"
}'

{
  "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",
    "title": "string"
  }
}

Was this helpful?

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

See also

Endpoint Authentication

Try it

Authorization

`Authorization`
Required
Bearer <token>

Request Body

`userId`string

`displayName`string

`emails`array<object>

`active`boolean

`name`object

`userName`string

`title`string

Path Parameters

`userId`
Required
string

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

See also

Endpoint Authentication

Try it

Path

Authorization

AuthorizationRequiredBearer <token>

Request Body

userIdstring

displayNamestring

emailsarray<object>

Object 1

activeboolean

nameobject

name

userNamestring

titlestring

Path Parameters

userIdRequiredstring

Response

Typescript

`Authorization`
Required
Bearer <token>

`userId`string

`displayName`string

`emails`array<object>

`active`boolean

`name`object

`userName`string

`title`string

`userId`
Required
string