Update a user
PATCH
/v1/users/{id}
const url = 'http://localhost:8080/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"displayName":"example","isActive":true,"password":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url http://localhost:8080/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Content-Type: application/json' \ --data '{ "displayName": "example", "isActive": true, "password": "example" }'Changes the display name, active flag and/or password; null fields are left untouched. Deactivating or resetting the password revokes every refresh token of the user. Administrators only. 404 for an unknown user, 400 for a password shorter than the policy minimum, 422 when the user’s email domain is no longer allowed by policy.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
displayName
null | string
isActive
null | boolean
password
null | string
Examplegenerated
{ "displayName": "example", "isActive": true, "password": "example"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
id
required
string format: uuid
email
required
string
displayName
required
string
roles
required
Array<string>
isActive
required
boolean
lastLoginAt
required
null | string format: date-time
totpEnrolled
required
boolean
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "email": "example", "displayName": "example", "roles": [ "example" ], "isActive": true, "lastLoginAt": "2026-04-15T12:00:00Z", "totpEnrolled": true}