Versions Compared

Key

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

openspecimen/rest/ng/users/{userId}/password?token={token}reset-password

Use this resource for set the password. 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 :

Parameter
Details
userIdloginNameIdentifier of user e.g. 22, 12 etctokenOpenSpecimen login name of user whose password want to reset
resetPasswordTokenApplication generated token to set the password which has sent through email
newPasswordPassword that user wants to set


http[s]:<host>:<port>/openspecimen/rest/ng/users/{userId}/password?token={token}reset-password

Use this URL to set password in openSpecimen application.

...

URLhttp://<host>:<port>/openspecimen/rest/ng/users/{userId}/password?token={token}reset-password
MethodPUTPOST
Requestapplication/json
json
Code Block
languagejs
themeEclipse
linenumberstrue
{
   "loginName": "jon.snow@domain.com",
   "newPassword":
"Login1234"
 "Login!@3",
   "resetPasswordToken": "dd683501-42b5-4e8a-918c-1a81dac9b936"
}

Response

"successtrue"


 Error Cases :

code
Applies to
Status Message
200All resourcesPassword has been updated successfully
400All requestsInvalid parameters, e.g blank new password etc401All requestsAuthorization failed, user doesn’t have authority
404All requestsUser not found, user with given details not present in the system
500All requestsInternal server error, encountered server error while performing operations

...