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

id
string
required
UUID of the user to update.

Update by Name

Use PATCH /v1/users/name/{fqn} to update by fully qualified name.
fqn
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.
displayName
string
Updated display name.
description
string
Updated description in Markdown format.
email
string
Updated email address.
isAdmin
boolean
Updated admin status.
teams
array
Updated list of team references.
roles
array
Updated list of role references.
domain
string
Updated domain FQN.
profile
object
Updated profile information.
PATCH /v1/users/{id}

Returns

Returns the updated user object with the new version number.

Response

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

Error Handling