Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

openspecimen/rest/ng/users/{loginName}/forgotPasswordforgot-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:

...

http[s]:<host>:<port>/openspecimen/rest/ng/users/{loginName}/forgotPasswordforgot-password

Use this URL to forgot password in openSpecimen application. 

Result:

The response of this request will contains the details of the forgotten password.

...

URLhttp://<host>:<port>/openspecimen/rest/ng/users/{loginName}/forgotPasswordforgot-password
MethodPUT
Requestapplication /json
json
Code Block
languagejs
themeEclipse
{
    "loginName": "jon.snow@domain.com"
}

Response

 "successtrue"

 

 Error Cases :

Authorization failed, user doesn’t have authority
code
Applies to
Status Message
200All resourcesPassword link sent successfully401All requests
404All requestsUser not found, user with given details not present in the system
500All requestsInternal server error, encountered server error while performing operations