...
...
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 |
---|---|---|---|---|---|
idusername | Query | YES | String | N/A | User IDUsername |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ result: true, data: { token: %token%, link: { forgotPassword: 'http://dashboard.soajs.org/#/resetPassword?token=%token%' } } }true } |
Invalid Response
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "result":false, "errors":{ "codes":[602], "details":[ { "code":602, "message":"Model error: + %model_error%" } ] } } |
Response schema
Follow this link to check out the response JSON 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% |