...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /admin/user/pin | PUT | Users |
Description
This API edits, resets, or deletes the pin information of a user that has a username, email, or id that matches the one sent in the user object in the request body.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| user | Body | YES | Object | Includes one of id, username, or email | User Object | ||||||||||||||||||||
One of the following should exist under the user object:
| |||||||||||||||||||||||||
| pin | Body | YES | Object | One of delete or reset with allowed | Pin Object | ||||||||||||||||||||
One of the following should exist under the pin object:
| |||||||||||||||||||||||||
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%"
}
]
}
} |
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 520 | Unable to find user |
| 525 | Unable to generate pin at this time |
| 602 | Model error: + %model_error% |