Change user account password

Edit online

Change a password for the user account. If the account is locked, changing the password unlocks the user account as well. A password change can be done by an administrator or REST over SCSI session on any account. It can also be done by any user on their own account, but in this case expirePassword must be set to no.

Request syntax

POST /v1/authentication/userAccounts/{name}/setPassword{"password": <new password or temporary password>, "expirePassword": <"yes"|"no">}
Change a password for the user account.

Path parameters

name (string): The unique name of the user account.

Request body parameters

password (string, required): The new password to be assigned to the user account.
expirePassword (string, required): Whether the password specified will be set as expired. An expired password must be changed when that user next logs in. Values include yes or no. If a user is modifying their own password, this must be set to no.

Example

> POST /v1/authentication/userAccounts/admin5/setPassword 
{"password": "tempPass4You", "expirePassword": "yes"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

Returns 400 Bad Command if an invalid password is given with details in the error_description with what is required.
Returns 422 Unprocessable Entry if a user is modifying their own password and expirePassword is set to no. This is not possible with REST over SCSI (RoS).