Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/account/changePasswordPOST


Data Model: %Link to Data Model% Users

Workflow: %Link to Architecture Page%

...

  
NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/AUser id
oldPasswordBodyYESStringN/AOld Password
passwordBodyYESStringN/ANew Password
confirmationBodyYESStringN/Asame value as password

 

Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": {
		"..."	
	}
true
}

 

Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[400],
        "details":[
            {
                "code":400,
                "message":"Problem with the provided password"
            }
        ]
    }
}



Error Codes


 

Database Error
Code
Description
400
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
408The password and its confirmation do not match
409Invalid old password provided
411invalid user id provided


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR API
 > CURL -X POST http://127.0.0.1:4000/...urac/account/changePassword?uId=123 -d 'oldPassword=johnoldpassword&password=johnpassword&confirmation=johnpassword'

Response

Code Block
languagejs
titleYOUR API response
{
	"result": true,
	"data": {
		"_id": "57063608622c47b5c097d19b",
		"..."
	}true
}