Skip to main content
PATCH
PATCH /v1/users/{id}

Update a User

Update a user’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

string
required
UUID of the user to update.

Update by Name

Use PATCH /v1/users/name/{fqn} to update by fully qualified name.
string
required
Fully qualified name of the user (e.g., aaron_johnson0).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
string
Updated display name.
string
Updated description in Markdown format.
string
Updated email address.
boolean
Updated admin status.
array
Updated list of team references.
array
Updated list of role references.
string
Updated domain FQN.
object
Updated profile information.
PATCH /v1/users/{id}

Returns

Returns the updated user object with the new version number.

Response

string
Unique identifier for the user (UUID format).
string
Username.
string
Fully qualified name (same as name for users).
string
Updated description.
number
Incremented version number.

Error Handling