Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/resetPasswordPOST


Data Models: UsersTokens

Workflow: %Link to Architecture Page% Reset Password Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
tokenQueryYESStringN/AGenerated by Urac and email to user after forgot password request is made.
passwordBodyYESStringN/A
 

confirmationBodyYESStringN/Asame value as password

...


Output

...

Valid Response

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

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[408],
        "details":[
            {
                "code":408,
                "message":"The password and its confirmation do not match"
            }
        ]
    }
}



Error Codes



 

Code
Description
406Invalid or token has expired.
407Problem validating Request. Please try again.
408The password and its confirmation do not match



Example (CURL)

...

Request

Code Block
languagebash
titleCalling resetPassword Reset Password API
 > CURL -X POST http://127.0.0.1:4000/resetPassword?token=abcdef -d 'password=johnpassword&confirmation=johnpassword'

...

Code Block
languagejs
titleresetPassword Reset Password API response
{
	"result": true,
	"data": true
}

...