Patch User

patch

https://{hostname}/scim/v1/Users/{id}

Use this endpoint to update one or more attributes of a user.

Path Params

integer

required

The unique ID of the SCIM resource.

Query Params

attributes

string

When included, each resource returned will contain the minimum set of resource attributes and any attributes or sub-attributes explicitly requested.

excludedAttributes

string

When included, each resource returned will contain the minimum set of resource attributes. Additionally, the default set of attributes minus those attributes listed in "excludedAttributes" is returned.

Body Params

Request body parameters for updating one or more attributes of a user.

schemas

array of strings

A schema for representing the patch request.

schemas

Operations

array of objects

length ≥ 1

A list of operations, whose value is an array of one or more patch operations.

Operations

string

enum

required

Indicates the operation to perform.

Allowed:

path

string

Indicates an attribute path describing the target of the operation.

value

string

Specifies the value to be added or replaced.

Headers

string

enum

Defaults to application/scim+json

Generated from available response content types

Allowed:

Responses

400

Invalid format or content of the request.

401

The SCIM token is invalid.

403

The request is not authorized by the server.

404

A required entity is missing.

409

A conflict occurred with the current state of the target resource.

Language

Credentials

Bearer

URL

Response

Choose an example:

application/scim+json

application/json

201Returns the updated user, optionally filtered by values in attributes or excludedAttributes parameters.