---
title: "User ACL object"
url: "https://help.internetx.com/en/api/core-user-acl-object/"
lang: "en"
section: "API reference — API reference (XML/JSON)"
breadcrumb: "API documentation (JSON/XML) > Objects"
updated: "2023-09-25"
---

# 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](/en/api/core-basic-user-object/) | The child users who should not be blocked for this right. |
| childrenLocked | childrenLocked | 1 | boolean |  | Should all the subordinate users be locked.<br>• false = Locked for all subusers<br>• true = Release for all subusers<br>Default value = true<br>For XML, 0 (false) and 1 (true) can also be used. |
| userLock |  | 1 | boolean |  | Should the logged in user be locked.<br>• true = Locked logged in user<br>• false = Enable logged in user<br>Default value = true<br>For XML, 0 (false) and 1 (true) can also be used. |
| effective |  | 1 | boolean |  | The current effective rights. |
| childrenRem |  | 0 - n | object | [Basic User](/en/api/core-basic-user-object/) | Children to remove from the exception list |
| childrenAdd |  | 0 - n | object | [Basic User](/en/api/core-basic-user-object/) | Children to add to the exception list |
| restriction |  | 1 | enum | [ACLRestriction](/en/api/core-acl-restriction-enum/) | Describes the restriction as a result of the authorisation check. The object defines the different types of restrictions. |