- Home
- API reference
- API documentation (JSON/XML)
- Objects
User ACL object
Description
The UserACL object maps the user rights to his or her subusers.
Structure
| Keyword JSON | Keyword XML | Occurs | Type | Format | Description |
|---|---|---|---|---|---|
| functionCode | code | 1 | string | The function code of the right to be edited. | |
| children | children | 0 - n | object | Basic User | The child users who should not be blocked for this right. |
| childrenLocked | childrenLocked | 1 | boolean | Should all the subordinate users be locked.
Default value = true For XML, 0 (false) and 1 (true) can also be used. | |
| userLock | 1 | boolean | Should the logged in user be locked.
Default value = true For XML, 0 (false) and 1 (true) can also be used. | ||
| effective | 1 | boolean | The current effective rights. | ||
| childrenRem | 0 - n | object | Basic User | Children to remove from the exception list | |
| childrenAdd | 0 - n | object | Basic User | Children to add to the exception list | |
| restriction | 1 | enum | ACLRestriction | Describes the restriction as a result of the authorisation check. The object defines the different types of restrictions. |