# GetServerAcl

## General

### URL

https://[host]/attunityenterprisemanager/api/v1/servers/[server]?action=acl

### Description

Retrieves the explicit ACL defined in Qlik Enterprise Manager for the specified server, including a Boolean indication if ACL inheritance is disabled or enabled for the server.

The method returns the explicit ACL only. In other words, it does not return inherited ACLs.

If all of the servers ACLs are inherited (that is, no ACL was explicitly defined for the server), an error will be returned indicating that no ACL was found.

This method can be used together with ` PutServerAcl  `in order to update an existing server's ACL. First call `GetServerAcl`, then edit the returned roles as required, and finally, call `PutServerAcl`.

### HTTP method

GET

### Required user role

See [Required Enterprise Manager permissions](https://help.qlik.com/en-US/enterprise-manager/May2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Introduction/AEMPermissions.htm).

## Request parameters

Request parameters

| Location | Name | Required | Example |
| --- | --- | --- | --- |
| URL | Host [string] | Yes | computer.network.net |
| URL | ServerName [string] | Yes | myrepsrv1 |
| Header | EnterpriseManager.APISessionID [string] | Yes | wCo0\_KvjEUFROvfHF5KGrw |

## Response body

`{`

`"admin_role":     {`

`"users": [  { "name": "{string}"}, { "name": "{string}"}, … ],` `"groups": [  { "name": "{string}"}, { "name": "{string}"}, … ]` `},`

`"designer_role": {`

`"users": [  { "name": "{string}"}, { "name": "{string}"}, … ],` `"groups": [  { "name": "{string}"}, { "name": "{string}"}, … ]` `},`

`"operator_role": {`

`"users": [  { "name": "{string}"}, { "name": "{string}"}, … ],` `"groups": [  { "name": "{string}"}, { "name": "{string}"}, … ]` `},`

`"viewer_role": {`

`"users": [  { "name": "{string}"}, { "name": "{string}"}, … ],` `"groups": [  { "name": "{string}"}, { "name": "{string}"}, … ]` `},`

`"disable_inheritance": "{bool}"`

`}`

## Response parameters

* admin\_role

  * users: An array of users assigned as Admins on the server.

    * name: A single Admin user.

  * groups: An array of groups assigned as Admins on the server.

    * name: A single Admin group.

* designer\_role

  * users: An array of users assigned as Designers on the server.

    * name: A single Designer user.

  * groups: An array of groups assigned as Designers on the server.

    * name: A single Designer group.

* operator\_role

  * users: An array of users assigned as Operators on the server.

    * name: A single Operator user.

  * groups: An array of groups assigned as Operators on the server.

    * name: A single Operator group.

* viewer\_role

  * users: An array of users assigned as Viewers on the server.

    * name: A single Viewer user.

  * groups: An array of groups assigned as Viewers on the server.

    * name: A single Viewer group.

* disable\_inheritance: If set to "true", the server does not inherit ACLs from its ancestors (in addition to its explicit ACLs). If set to "false", the server inherits ACLs from its ancestors, in addition to any explicit ACLs.

Response parameters

| Name | A | B | Description |
| --- | --- | --- | --- |
| admin\_role | - | - | - |
| - | users | - | An array of users assigned as Admins on the server. |
| - | - | name | A single Admin user. |
| - | groups | - | An array of groups assigned as Admins on the server. |
| - | - | name | A single Admin group. |
| designer\_role | - | - | - |
| - | users | - | An array of users assigned as Designers on the server. |
| - | - | name | A single Designer user. |
| - | groups | - | An array of groups assigned as Designers on the server. |
| - | - | name | A single Designer group. |
| operator\_role | - | - | - |
| - | users | - | An array of users assigned as Operators on the server. |
| - | - | name | A single Operator user. |
| - | groups | - | An array of groups assigned as Operators on the server. |
| - | - | name | A single Operator group. |
| viewer\_role | - | - | - |
| - | users | - | An array of users assigned as Viewers on the server. |
| - | - | name | A single Viewer user. |
| - | groups | - | An array of groups assigned as Viewers on the server. |
| - | - | name | A single Viewer group. |
| disable\_inheritance | - | - | If set to "true", the server does not inherit ACLs from its ancestors (in addition to its explicit ACLs). If set to "false", the server inherits ACLs from its ancestors, in addition to any explicit ACLs. |

## cURL example

### Request

`curl -i -k --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGr" https://computer.network.net/attunityenterprisemanager/api/v1/servers/myrepsrv1?action=acl"
`

### Response

` Headers:
                 `

`HTTP/1.1 200 OK`

`Cache-Control: no-cache, no-store`

`Content-Length: 502`

`Content-Type: application/json; charset=utf-8`

`Server: Microsoft-HTTPAPI/2.0`

`Date: Mon, 26 Dec 2016 13:18:27 GMT`

### Payload

`{`

`"admin_role": {`

`"users": [`

`{"name": "QLIK\\Paul.Clarke"},`

`{"name": "QLIK\\testAuth1"}`

`],`

`"groups": [`

`{"name": "QLIK\\AttunityEnterpriseManagerAdmins"}`

`]`

`},`

`"designer_role": {`

`"users": [`

`{"name": "QLIK\\Marisa.Lewis"},`

`{"name": "QLIK\\testAuth2"}`

`],`

`"groups": [`

`{"name": "QLIK\\AttunityEnterpriseManagerDesigners"}`

`]`

`},`

`operator_role": {`

`"users": [`

`{"name": "QLIK\\David.Foster"},`

`{"name": "QLIK\\testAuth3"}`

`],`

`"groups": [`

`{"name": "QLIK\\AttunityEnterpriseManagerOperators"}`

`]`

`},`

`"viewer_role": {`

`"users": [`

`{"name": "QLIK\\Laura.Todd"},`

`{"name": "QLIK\\testAuth4"}`

`],`

`"groups": [`

`{"name": "QLIK\\AttunityEnterpriseManagerViewers"}`

`]`

`},`

`"disable_inheritance": true

`

`}`

## Error response

All of the [general errors](https://help.qlik.com/en-US/enterprise-manager/May2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/CurlAPI/error_handling.htm) as well as the errors listed in the table below.

Error responses

| HTTP Code | Enterprise Manager Code | Text | Description |
| --- | --- | --- | --- |
| 500 | AEM\_GET\_SERVER\_ACL\_INNER\_ERR | Failed to get ACL of server "{server}".<br><br>Error: "{message}". | Returned if Qlik Enterprise Manager encounters an error/exception when trying to get the server ACL. |
| 500 | AEM\_SERVER\_HAS\_NO\_ACL | ACL for server "{server}" could not be found. | Returned if no explicit ACL is defined for the server.<br><br>Information note<br><br>A server that does not have its own explicit ACL inherits the ACL from its ancestors. Inherited ACLs are not returned by this method. |