Versions Compared

Key

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

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflow
urac

/password/forgot

GETUsersN/A

Description

This API resets the password of an account if forgotten by providing an account id in the querythe user (username or email).

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernameQueryYESStringN/AUsername


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:    { token: %token%,
     link:
      { forgotPassword:
         'http://dashboard.soajs.org/#/resetPassword?token=%token%' 
      } 
   }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

599

Token has expired

520

Unable to find user

600

unable to find token

602Model error: + %model_error%