...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /password/reset | PUT | Users | N/A |
Description
This API allows user to reset an account password by providing a token in the request body.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| token | Body | YES | String | N/A | Token |
| password | Body | YES | String | N/A | Password |
| Confirmationconfirmation | Body | YES | String | Must match password | Password Confirmation |
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: 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 |
| 520 | Unable to find user |
| 522 | The password and its confirmation do not match |
| 599 | Token has expired |
| 600 | unable to find token |
| 602 | Model error: + %model_error% |