Forgot Password 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 this API using HTTP PUT method, URL http://<host>:<port>/catissuecore/rest/ng/users/{loginName}/forgotPassword 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 | CaTissue OpenSpecimen login name of user whose password is forgotten. |
API Example 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>/catissuecoreopenspecimen/rest/ng/users/{loginName}/forgotPasswordforgot-password | |||||||
| Method | PUT | |||||||
| Request | application /json | |||||||
| json |
| |||||||
Response | "successtrue" |
Error Cases :
code | Applies to | Status Message | |||
|---|---|---|---|---|---|
| 200 | All resources | Password link sent successfully | 400 | All requestsInvalid parameters, e.g duplicate Login Name, duplicate Email Address, blank First Name etc | |
| 401 | All requests | Authorization failed, User doesn’t have Authority | |||
| 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 |
...