Update User

PUT {{URL}}/v1/users/{{UserUsername}}

A user with the role of ROLE_ADMIN can update the password associated with user accounts with roles of ROLE_ADMIN and ROLE_USER. Individual users can also update the password for their own accounts. Updating a user account password does not invalidate any access tokens associated with the user. Currently, only user admin has ROLE_ADMIN; other users have ROLE_USER.

Only the admin account is used to manage accounts, that is actions such as creating or removing users. If you forget your password, please contact Direct Support for assistance with resetting it.

If successful, the password associated with the username is updated. The HTTP status code 200 OK is returned, along with a payload similar to response in the example.

If not successful, the response may contain on the following HTTP status codes:

HTTP Status CodeReason
400Bad request.
401Unable to validate the credentials.
404 Not FoundA user account with the username submitted in the request was not found.
500Unknown reason

If there are other errors in the response, refer to the following sources for more information: Error Codes and HTTP Status Codes.

Request Body

{"password"=>"<New Password>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring