Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Users

Patch User

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

patch/Users/{id}

Path parameters

idinteger required

The unique ID of the SCIM resource.

Query parameters

attributesstring

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

excludedAttributesstring

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.

Request body

schemasstring[]

A schema for representing the patch request.

Response

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

activeboolean

Indicates if the user is active/enabled.

displayNamestring

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

passwordstring

Compatibility attribute. Write-only, never returned. Writes are discarded.

externalIdstring nullable

A custom, user-supplied ID.

idstring

The ID of this resource instance.

localestring

Indicate the User's default location for purposes of localization. It is the language tag only (no region).

schemasstring[]

A schema for representing the user's configuration.

titlestring nullable

The user's title.

userNamestring

A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider.

Example response

{
  "locale": "en",
  "title": "Vice President"
}