Versions Compared

Key

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

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.

Api :

...

Method

...

URL

...

. 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
loginNameOpenSpecimen 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:

URLhttp://<host>:<port>/openspecimen/rest/ng/users/{loginName}/forgotPasswordforgot-password
MethodPUT
Requestapplication /json
json

Response

 "success"

 

Parameter Details :

{loginName} :  CaTissue login name of user whose password is forgotten.

e.g. dpatil, admin@admin.com etc.

 

Code Block
languagejs
themeEclipse
{
    "loginName": "jon.snow@domain.com"
}

Response

 "true"

 

 Error Cases :

code
Applies to
Status Message
200All resources 
400All requestsInvalid parameters, this will also includes application specific error messages
401All requestsAuthorization failed
Password link sent successfully
404All requestsResource User not found, also includes specified resource id/name/titleuser with given details not present in the system
500All requestsInternal server error

 

 

...

, encountered server error while performing operations