Page Comparison

openspecimen/rest/ng/users/{userId}/password?type=change

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

userId User 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!

newPassword New user password

that user wants to change

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

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
Method	PUT
URL	/openspecimen/rest/ng/users/

{userId}/password?type=changeRequest

password
Content type	application/json

json{

Body

Code Block

language	js
theme	Eclipse
linenumbers	true

{
    "userId": 134,
    "oldPassword": "

Login123

Login!@3",
    "newPassword": "

Login1234

Admin!@3"
}

Response

"

success

true"

Error Cases :

code

Applies to

Status Message

200All resources

HTTP Response Code	Description
200	Password has been updated successfully
400

All requests

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

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

Versions Compared

Old Version 16

New Version Current

Key