Updates an existing user

PATCH /users/{user_name}

Auth

Updates an existing user.

Path parameters

user_name string required: Identifier for the user

All changes in the specified object are applied to the user according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a null value reverts the field to the default value, or removes the field when no default value exists.

Type: string

Responses

User successfully updated

application/json

user_name string required: The user's identifier
security object required: A user's security information
metadata object: Metadata for a user
full_name string: The user's optional full name
email string: The user's optional email address
builtin boolean: True if the user is a built-in read-only user

Some of the provided roles are invalid. (code: user.roles.invalid)
Some of the provided roles are forbidden. (code: user.roles.forbidden)
Trying to set a restricted field. (code: user.restricted_field)
External users cannot be modified. (code: user.cannot_modify_external)
Built-in users cannot be modified. (code: user.cannot_modify)

application/json

User not found. (code: user.not_found)

application/json

Updates an existing user

Path parameters

Request body

Responses

Response headers

Response headers