General Information
...
| Service | API | Method |
|---|
| urac | /admin/editUserConfig |
GET
...
Data Model: %Link to Data Model%
Workflow: %Link to Architecture Page%
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 |
String | Object | N/A |
|
|
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| keys | Body | NO | Object | N/A |
| | packages | Body | NO | Object | N/A | Additional Properties: acl (Object) | | allowedTenants | Body | NO | Object |
|
|
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| tenant | Body | NO | Object |
| Properties: |
|
|
...
- id (String)
- code (String)
- pin (Object)
- code (String)
- allowed (Boolean)
| | groups | Body | NO | Array |
|
|
|
example config: | Code Block |
|---|
| language | actionscript3 |
|---|
| title | 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
| 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":[400405],
"details":[
{
"code":400405,
"message":"Problem with the provided passwordUnable to find User. Please try again."
}
]
}
} |
Error Codes
| 400 | Database Error |
|---|
| 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
| Code Block |
|---|
| language | bash |
|---|
| title | Calling YOUR 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
| Code Block |
|---|
| language | js |
|---|
| title | YOUR Edit User Config API response |
|---|
|
{
"result": true,
"data": {
"_id": "57063608622c47b5c097d19b",
"..."
}true
} |