Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/account/changePasswordPOST


Data Model: Users

Workflow: %Link to Architecture Page%

...

WorkFlow: Change Password Flow


Input

...

Type: application/json
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

 



Code
Description
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 Change Password API
 > CURL -X POST http://127.0.0.1:4000/urac/account/changePassword?uId=123 -d 'oldPassword=johnoldpassword&password=johnpassword&confirmation=johnpassword'

...

Code Block
languagejs
titleYOUR Change Password API response
{
	"result": true,
	"data": true
}

...