Versions Compared

Key

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

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflow
urac

/password/reset

PUTUsersN/A

Description

This API allows user to reset an account password by providing a token in the request body.

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
tokenBodyYESStringN/AToken
passwordBodyYESString N/APassword
ConfirmationconfirmationBodyYESStringMust match passwordPassword Confirmation


Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
  result: true,
  data: true
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

520

Unable to find user

522

The password and its confirmation do not match

599Token has expired
600

unable to find token

602Model error: + %model_error%