Update SCIM user

put/scim/v2/Users/{userId}

Updates a SCIM user. The userName should be set by the client within the request body.

Request Samples

1

Response Samples

1{
2  "id": "2bca4a63-0892-484a-a9ef-aff7b7f0c795",
3  "userName": "scim-example3@sas.com",
4  "title": "Senior Engineer",
5  "active": true,
6  "externalId": "scim-example3@sas.com",
7  "displayName": "SCIM Example User 3 - Updated",
8  "emails": [
9    {
10      "value": "scim-example3@sas.com",
11      "type": "work"
12    },
13    {
14      "value": "example3@personal.com",
15      "type": "home"
16    }
17  ],
18  "phoneNumbers": [
19    {
20      "value": "919-555-1234",
21      "type": "work"
22    }
23  ],
24  "addresses": [
25    {
26      "type": "work",
27      "streetAddress": "100 SAS Campus Drive",
28      "locality": "Cary",
29      "region": "NC",
30      "country": "US",
31      "postalCode": "27513"
32    }
33  ],
34  "schemas": [
35    "urn:ietf:params:scim:schemas:core:2.0:User"
36  ],
37  "meta": {
38    "resourceType": "User",
39    "created": "2025-10-16T13:46:46.111Z",
40    "lastModified": "2025-10-16T14:01:31.647Z"
41  }
42}

Path Parameters

NameTypeRequiredDescription
userId
string<object-id>
true

Unique identifier for the user resource (SCIM ID).

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The entity tag (ETag) value of the resource. If provided, the request succeeds only if the current resource version matches this value.

If-Unmodified-Since
string<date-time>
false

A date-time value. If provided, the request succeeds only if the resource has not been modified since the specified date.

Request Body

SCIM 2.0 User resource for POST and PUT requests (user creation and updates). Note that id is server-generated and should not be included in requests.

NameTypeRequiredDescription
schemas
array [string]
true

SCIM schemas URN array.

id
string
false

Unique identifier for the user resource (SCIM ID).

<= 100 characters
userName
string
true

Unique identifier for the user, typically used by the user to directly authenticate. REQUIRED.

<= 100 characters
Match pattern:
^(?!.*<[Ss][Cc][Rr][Ii][Pp][Tt][\s\S]*?>).*$
externalId
string
false

An identifier for the resource as defined by the provisioning client.

displayName
string
false

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

<= 100 characters
Match pattern:
^(?!.*<[Ss][Cc][Rr][Ii][Pp][Tt][\s\S]*?>).*$
title
string
false

The User's title, such as "Vice President".

<= 100 characters
active
boolean
false

A Boolean value indicating the User's administrative status.

emails
array [scimEmailAddress]
false

Email addresses for the user.

phoneNumbers
array [scimPhoneNumber]
false

Phone numbers for the user.

addresses
array [scimAddress]
false

Physical mailing addresses for the user.

meta
object
false

Resource metadata.

undefined
false

Responses

StatusMeaningDescription
200OK

The user updated successfully.

Schema
400Bad Request

The request was invalid.

401Unauthorized

Authentication is required.

403Forbidden

The authenticated user does not have sufficient privileges.

Schema
404Not Found

The SCIM user could not be found.

Schema
412Precondition Failed

The If-Match or If-Unmodified-Since header condition was not met.