GET - /password/forgot

General Information

Service	API	Method	Data Models	Workflow
urac	/password/forgot	GET	Users	N/A

Description

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

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
username	Query	YES	String	N/A	Username

Output

Response

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

Valid Response

Valid Response Sample

{ 
  result: true,
  data:
   { token: %token%,
     link:
      { forgotPassword:
         'http://dashboard.soajs.org/#/resetPassword?token=%token%' 
      } 
   }
}

Invalid Response

Error Response Sample

{
    "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
602	Model error: + %model_error%