openspecimen/rest/ng/users/password
Use this API to change the user passwords.
The following table lists the attributes that need to be sent in the API request body.
Parameter | Details |
|---|---|
| userId | User identifier |
oldPassword | Old password of the user. This is not mandatory if a) the super-admin user is invoking this API and b) the super-admin user is not changing his/her own password! |
| newPassword | New user password |
http[s]://<host>:<port>/openspecimen/rest/ng/users/password
Use this URL to change the user password
Below is an example of the change password API request/resposne.
Method | URL |
|---|---|
| Method | PUT |
| URL | /openspecimen/rest/ng/users/password |
| Content type | application/json |
| Body | {
"userId": 134,
"oldPassword": "Login!@3",
"newPassword": "Admin!@3"
}
|
Response | "true" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Password has been updated successfully |
| 400 | All requests | Invalid parameters, e.g blank old password, blank new password etc. |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 404 | All requests | User not found, user with given details not present in the system |
| 500 | All requests | Internal server error, encountered server error while performing operations |