General Information
...
| Service | API | Method |
|---|
| urac | /forgotPassword | GET |
Data Models: Users, Tokens
Workflow: %Link to Architecture Page% Forgot Password Flow
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| username | Query | YES | String | N/A | Username or Email |
...
Output
...
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
|
{
"result": true,
"data": "..."
} |
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
|
{
"result":false,
"errors":{
"codes":[406],
"details":[
{
"code":406,
"message":"Invalid or token has expired."
}
]
}
} |
Error Codes
| |
|---|
| 406 | Invalid or token has expired. |
| 407 | Problem validating Request. Please try again. |
Example (CURL)
...
Request
| Code Block |
|---|
| language | bash |
|---|
| title | Calling Forgot Password API |
|---|
|
> CURL -X GET http://127.0.0.1:4000/urac/forgotPassword?username=john |
...
| Code Block |
|---|
| language | js |
|---|
| title | Forgot Password API response |
|---|
|
{
"result": true,
"data": "819b0aed-edd8-47d5-ada0-9e5f93cb8248"{ token: '18c24bd2-63db-4191-bd1c-4111d68f96f9',
link:
{ forgotPassword: 'http://dashboard.soajs.org/#/resetPassword?token=18c24bd2-63db-4191-bd1c-4111d68f96f9' } }
} |