Update local user password
Edits a local user's password.
This topic includes the following sections:
For a video demonstration of how to use this call, see Local-user-and-role-management-API.
Request
HTTP method: POST
URL: https://<hostname>:<port>/rsso/config/local/user/updatepassword
Header: For header information, such as required authentication token, see Remedy-SSO-administrator-Login-and-Logout-calls.
Request body properties
Property | Type | Required | Description | Values | Default value |
|---|---|---|---|---|---|
loginName | String | Yes | Login name of the user whose password will be changed | User-provided value Existing user-defined value | NA |
newPassword | String | Yes | New password for the user Minimum 8 characters long | User-provided value | NA |
confirmPassword | String | Yes | The same password as provided for newPassword property | User-provided value | NA |
Example request JSON
"loginName":"aoadmin1",
"newPassword":"aoadmin2",
"confirmPassword":"aoadmin2"
}
Response
If successful, this method modifies the specified local user's password.
Response body properties
Property | Description |
|---|---|
code | Status code (see Status codes and messages) |
msg | Status |
data | NA |
Example response JSON
"code":200,
"msg":"OK",
"data":{}
}
Status codes and messages
For more details about HTTP response codes, see HTTP response codes.
HTTP code | Message (msg) | Description |
|---|---|---|
200 | OK | Request succeeded |
400 |
| Bad request |
New password and confirm password values are not the same | New and confirm password property values were different | |
Password is not at least 8 characters long | The specified password was not 8 characters long (it must be at least 8 characters long) | |
Zero records updated while updating password for user does not exist | Specified login name does not exist |
Related topics