Users

Update user account

Updates user account information including role assignments, password changes, or other profile details. Users can modify their own account settings, while administrators have broader permissions to update any user account. Password changes require the new password to be at least 15 characters long by default or comply to the defined password policy for security compliance. Setting remove_lockout releases an active failed-login lockout and resets the counters; it answers to the same gate as an administrative password reset, so Root or Admin on the organization, and never the locked-out user themselves.

put/api/{org_id}/users/{email_id}

Request

Path parameters

org_idstring required

Organization name

email_idstring required

User's email id

Request body

custom_rolestring[] nullable
rolestring required
change_passwordboolean
first_namestring nullable
last_namestring nullable
new_passwordstring nullable
old_passwordstring nullable
remove_lockoutboolean

Releases an active failed-login lockout and resets the counters. Nothing else ends one early — not even a password change, since the lock records attempts rather than the password — and it is gated like a password reset by an administrator.

tokenstring nullable

Response

Success

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

No recorded changes to this operation across all 1 revision of this API.