Skip to main content

UserUpdateRequest

Request body to update a user's mutable fields. Every field is optional; only the provided fields change (optimistic-locked). The user's email, last_login, raw info map, and version are never accepted.

display_namestringnullable

Optional display name of the user

Example: Jane Doe
preferred_languagestringnullable

Preferred language code for the user

Possible values: [en, es, ar]

Example: en
is_system_adminbooleannullable

Whether the user is a platform system administrator (super-user)

Example: false
statusstringnullable

Account status

Possible values: [active, inactive, suspended]

Example: active
UserUpdateRequest
{
"display_name": "Jane Doe",
"preferred_language": "en",
"is_system_admin": false,
"status": "active"
}