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

Applies a SCIM PATCH to a user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
scimId

The SCIM identifier of the user to update.

string

Required

Body Parameters

The SCIM PatchOp request describing the operations to apply.

PatchRequest
NameDescriptionTypeAdditional information
schemas

Collection of string

None.

operations

Collection of PatchOperation

None.

Request Formats

application/json, text/json

Sample:
{
  "schemas": [
    "sample string 1",
    "sample string 2"
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/scim+json

Sample:
{
  "operations": null,
  "schemas": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

ScimUser
NameDescriptionTypeAdditional information
name

Name

None.

active

Nullable so a PUT that omits active leaves the user's state alone rather than deactivating them (RFC 7644 §3.5.1). Always set on users we return.

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.