Versions Compared

Key

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

openspecimen/rest/ng/users/password

Use this resource for change the password in the OpenSpecimen application. Use HTTP PUT method to call this API by passing the below details in JSON format.

Below are the attributes which

API to change the user passwords.

The following table lists the attributes that need to be sent in the API request

:

 body.


Parameter
Details
userIdUser identifier
oldPassword

Old password of the user.

This is not mandatory if

a) the super-admin user is invoking this API and

b) the super-admin user is not changing his/her own password!

newPasswordNew user password
that user wants to change


http[s]://<host>:<port>/openspecimen/rest/ng/users/password

Use this URL to change the user password in openSpecimen application.Result:

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

Below is the an example of the change password :API request/resposne.

Method
URL
MethodPUT
URL/openspecimen/rest/ng/users/password
Request
Content typeapplication/json
json
Body


Code Block
languagejs
themeEclipse
linenumberstrue
{
    "userId": 134,
    "oldPassword": "Login!@3",
    "newPassword": "Admin!@3"
}


Response

"true"


 Error Cases :

code
Applies to
Status Message
HTTP Response Code
Description
200
All resources
Password has been updated successfully
400
All requests
  1. Invalid parameters
, e.g  blank old password, blank new password etc.401All requestsAuthorization failed, user doesn’t have authority404All requestsUser not found, user with given details not present in the system500All requestsInternal server error, encountered server error while performing operations

 

 

 

 
  1. - empty new password, userId not specified
  2. User doesn't have rights to change the password
  3. User (userId) does not exist
  4. Input old password does not match etc
500Unknown, unhandled system errors.