General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /admin/editUseruser | PUT |
...
...
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | |
|---|---|---|---|---|---|---|
| uIdid | Query | YES | String | N/A | User ID | |
| username | Body | YES | String | alphanumeric with _ , - characters only | Username | |
| firstName | Body | YES | String | N/A | First Name | |
| lastName | Body | YES | String | N/A | Last Name | |
| Body | YES | String | Email Address Format (JSON Schema Validation) | |||
| status | Body | YES | String - Enum | 'active', 'inactive' , 'pendingNew' | restricted to either 'active' OR , 'inactive', or 'pendingNew' | |
| groups | Body | NO | Array | Array of Strings | array of group code values | |
| profile | Body | NO | Object | N/A | passwordProfilebody | |
Output
...
Properties:
- id (String)
- code (String)
- pin (Object)
- code (Boolean)
- allowed (Boolean)
...
Example of config:
| Code Block | ||||
|---|---|---|---|---|
| ||||
config: {
packages: {},
keys: {},
allowedTenants: [
{"tenant": {
id: "THYME_tID",
code: "THYME_CODE",
pin: {"code": "1235", "allowed": true}
},
groups: ["waiter"]
},
{tenant: {
id: "ELVIRA_tID",
code: "ELVIRA_CODE"
},
groups: ["manager]
}
]
}, |
...
Output
Valid Response
...
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
} |
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[405602],
"details":[
{
"code":405602,
"message":"UnableModel toerror: find User. Please try again.+ %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
Code | Description |
|---|
Example (CURL)
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X POST http://127.0.0.1:4000/urac/admin/editUser?uId=123 -d 'username=john&firstName=John&lastName=Doe&email=johndoe@domain.com&status=active' |
Response
...
| language | js |
|---|---|
| title | Edit User API response |
...
| 400 | Business logic required data are missing |
| 602 | Model error: + %model_error% |