Forgot Password API seds email to user with new password update link
...
Method
...
URL
...
openspecimen/rest/ng/users/forgot-password
Use this resource to get forgot password email link. Forgot password API sends application generated set password link through email to user. 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 body:
Parameter | Details |
|---|---|
loginName | OpenSpecimen login name of user whose password is forgotten. |
http[s]:<host>:<port>/openspecimen/rest/ng/users/forgot-password
Use this URL to forgot password in openSpecimen application.
Result:
The response of this request will contains the details of the forgotten password.
Below is the example of the forgot password:
| URL | http://<host>:<port>/openspecimen/rest/ng/users/{loginName}/forgotPassword |
| Request | Not Required |
| Response
| "success" |
...
| forgot-password | ||||||||
| Method | PUT | |||||||
| Request | application /json | |||||||
| json |
| |||||||
Response | "true" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Password link sent successfully |
| 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 |