POST/v1/user/managed

Update a managed user

Updates an existing managed user account. Supply username and lastPasswordChange, then include the account fields you want to update. You need the ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_UPDATE permission.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

11 body fields

Managed user account data. Supply username and lastPasswordChange; the other fields are optional.

confirmPasswordstringoptional
Confirmation of the new password.
emailstringoptional
The user's email address. Maximum 255 characters.
forcePasswordChangebooleanoptional
Whether the user must change their password.
fullnamestringoptional
The user's full name. Maximum 255 characters.
lastPasswordChangeintegerrequired
UNIX epoch timestamp in milliseconds
newPasswordstringoptional
The user's new password.
nonExpiryPasswordbooleanoptional
Whether the user's password is exempt from expiry.
permissionsarray<object>optional
Permission records associated with the user.
suspendedbooleanoptional
Whether the user account is suspended.
teamsarray<object>optional
Teams associated with the user.
usernamestringrequired
The user's username. Must be 1 to 255 characters.

4 status codes
200Returns the updated managed user object, including its username, account details, permissions, and teams.
confirmPasswordstringoptional
emailstringoptional
forcePasswordChangebooleanoptional
fullnamestringoptional
lastPasswordChangeintegerrequired
UNIX epoch timestamp in milliseconds
newPasswordstringoptional
nonExpiryPasswordbooleanoptional
permissionsarray<object>optional
suspendedbooleanoptional
teamsarray<object>optional
usernamestringrequired
400Returned when a required field is missing.
401Returned when the request is unauthorized.
404Returned when the user could not be found.

Error handling

A 400 is returned when a required field is missing; username and lastPasswordChange are required. A 401 is returned when you are not authorized, and a 404 is returned when the user identified by username cannot be found.