PUT api/scim/v2/users/{scimId}

Updates an existing user identified by SCIM ID with the provided modifications.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
scimId

The SCIM identifier of the user to be updated.

string

Required

Body Parameters

ScimUser
NameDescriptionTypeAdditional information
name

Name

None.

active

boolean

None.

userName

string

None.

emails

Collection of EMailAddress

None.

locale

string

None.

urn:ietf:params:scim:schemas:extension:sduserextension:2.0:User

Dictionary of string [key] and string [value]

None.

schemas

Collection of string

None.

id

globally unique identifier

None.

externalId

string

None.

meta

ResourceMetadata

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded, application/scim+json

Sample:

Sample not available.

Response Information

Resource Description

On success: HTTP 200 OK with the updated user object. On failure: HTTP 400 Bad Request or 404 Not Found depending on the error.

ScimUser
NameDescriptionTypeAdditional information
name

Name

None.

active

boolean

None.

userName

string

None.

emails

Collection of EMailAddress

None.

locale

string

None.

urn:ietf:params:scim:schemas:extension:sduserextension:2.0:User

Dictionary of string [key] and string [value]

None.

schemas

Collection of string

None.

id

globally unique identifier

None.

externalId

string

None.

meta

ResourceMetadata

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.