Forgot Password API sends application generated set password link through email to user.
Api :
...
Method
...
URL
...
Use HTTP PUT method, URL http://<host>:<port>/catissuecore/rest/ng/users/{loginName}/forgotPassword
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
logonName | CaTissue login name of user whose password is forgotten. |
API Example :
| URL | http://<host>:<port>/catissuecore/rest/ng/users/{loginName}/forgotPassword |
| Method | PUT |
| Request | application /json |
Response | "success" |
Parameter Details :
{loginName} : CaTissue login name of user whose password is forgotten.
...
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Password link sent 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 |
| 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 |
...