Update User

put

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

Use this endpoint to update a user. See User for more information.

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 a user.

active

boolean

Defaults to true

Indicates if the user is active/enabled.

displayName

string

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

name

object

Compatibility attribute, writes are allowed but discarded. Empty strings when read from.

password

string

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

roles

array of objects

length ≥ 0

roles

externalId

string | null

A custom, user-supplied ID.

groups

array of objects

length ≥ 0

A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.

groups

string

The ID of this resource instance.

locale

string

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

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