Set Password API is useful when user redirects through forgot password link or new user sets the password through email. Use this API by using HTTP PUT method, URL http://<host>:<port>/catissuecore/openspecimen/rest/ng/users/{userId}/password?token={token} reset-password
Use this resource for set the password. Use HTTP PUT method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request :
Parameter | Details | |
|---|---|---|
| userIdloginName | Identifier of User e.g. 22, 12 etc | tokenOpenSpecimen login name of user whose password want to reset |
| resetPasswordToken | Application generated token to set the Passwordpassword which has sent through email | |
| newPassword | Password that user wants to set |
...
http[s]:<host>:<port>/openspecimen/rest/ng/users/reset-password
Use this URL to set password in openSpecimen application.
Result:
The response of this request will contains the details of the updated password.
Below is the example of the set password:
| URL | http://<host>:<port>/catissuecoreopenspecimen/rest/ng/users/{userId}/password?token={token}reset-password | ||||||||||
| Method | PUTPOST | ||||||||||
| Request | application/json | ||||||||||
| json |
| ||||||||||
Response | "successtrue" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Password has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Login Name, duplicate Email Address, blank First Name etc |
| 401 | All requests | Authorization failed, User doesn’t have Authority |
| g blank new password etc | ||
| 404 | All requests | User not found, User user with given details not present in the system |
| 500 | All requests | Internal server error, Encountered encountered server error while performing operations |
...