Edit User Config
General Information
| Service | API | Method |
|---|---|---|
| urac | /admin/editUserConfig | POST |
Data Model: Users
workflow: Edit User Config Flow
Input
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| uId | Query | YES | String | N/A | the user id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| config | Body | YES | Object | N/A | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
example config: config 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
Valid Response Sample
{
"result": true,
"data": true
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[405],
"details":[
{
"code":405,
"message":"Unable to find User. Please try again."
}
]
}
}
Error Codes
Code | Description |
|---|---|
| 405 | Unable to find User. Please try again. |
| 407 | Problem validating Request. Please try again. |
| 411 | invalid user id provided |
| 500 | This record in locked. You cannot modify or delete it |
Example (CURL)
Request
Calling Edit User Config API
> CURL -X POST http://127.0.0.1:4000/urac/admin/editUserConfig?uId=123 -d "config={"keys": {"41eb3256ce660a891205d0a0eca19421":{"config": {"example01": {"tenantName": "Tenant name specific to user 123"}}}}"
Response
Edit User Config API response
{
"result": true,
"data": true
}