Skip to main content Skip to complementary content
Qlik Resources

PutServerAcl

General

URL

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

Description

Puts an explicit ACL for a specific server in Qlik Enterprise Manager.

The method will replace any existing explicit ACL with the ACL in the request.

The request also includes a Boolean flag for specifying if the server should inherit ACLs from its ancestors (in addition to its explicitly defined ACLs) or not.

The inherited ACLs (that is, the ACLs of the server's ancestors) are not affected by this method.

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

Behavior when putting a partial request

When the request body includes only some of the roles (as opposed to all four of them), only the roles specifically defined in the request body will be set on the server; roles that are missing or empty will be inherited, but only if the following are true:

  • The disable_inheritance flag is set to "True".
  • The roles that are missing/empty in the request are defined for the ancestors.

Behavior on conflicts

If the disable_inheritance flag is set to "False" and the explicit roles in the request conflict with existing inherited roles, then the explicit roles will take precedence. For example, if the request defines user A as a Viewer on MyServer and user A is also defined as an Admin on All Servers, then user A will be defined as an Admin on All Servers but as a Viewer on MyServer.

Information note

The user permissions in Enterprise Manager are completely independent of the user permissions in Replicate. Consequently, PutServerAcl will affect the server's Enterprise Manager user permissions, but will not affect Replicate's user permissions.

Moreover, when performing an operation via Enterprise Manager, the user permissions defined for the server entity in Enterprise Manager apply, whereas when performing an operation directly via the Replicate Console, the user permissions defined in Replicate apply.

Information note

Defining the same user/group in different roles is not allowed. However, if the same user or group is defined in different roles but with a different case (for example, Mike vs. mike or Analysts vs. ANALYSTS), no error will be returned and the strongest role will take precedence.

HTTP method

PUT

Required user role

See Required Enterprise Manager permissions.

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

Request 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}"

}

Request 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.EXE -i -k -X PUT --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGr" --header "Content-Length: 638" https://computer.network.net/attunityenterprisemanager/
api/v1/servers/myrepsrv1?action=acl" -T "C:\myrepsrv1Acl.json"

Request body

(defined in myrepsrv1Acl.json)

{
"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

}

Response 

Header:
HTTP/1.1 200 OK
Cache-Control: no-cache, no-store
Content-Length: 38
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Mon, 26 Dec 2016 16:31:01 GMT

Error response

All of the general errors as well as the errors listed in the table below.

Error responses
HTTP Code Enterprise Manager Code Text Description

500

DESERIALIZE_TO_TYPE

"Failed to deserialize json to type AemAuthorizationAcl: {message}"

Returned when the JSON format is invalid format. For example, such an error will be returned if the JSON contains an unknown role.

500

AEM_PUT_SERVER_ACL_INNER_ERR

Failed to put ACL of server "{server}".

Error: "{message}".

Returned if Qlik Enterprise Manager encounters an error/exception when trying to put the server's ACL.

500

AEM_NO_ DOMAIN_IN_USER

User "{userName}" must be preceded by a domain name, separated by a backslash.

Example:

domain_name\user_name.

Returned when the domain is missing from the user name.

500

AEM_NO_ DOMAIN_IN_GROUP

Group "{groupName}" must be preceded by a domain name, separated by a backslash.

Example:

domain_name\group_name.

Returned when the domain is missing from the group name.

500

AEM_NO_ADMIN_ON_SERVER

Requested server "{serverName}" has no admin user.

At least one user or group must be assigned to the "admin" role.

Returned when there is no admin on the server.

Possible reasons:

  • The request JSON is set to disable_inheritance=true and the explicit admin role in the JSON is empty.
  • The JSON is set to disable_inheritance =true, the explicit admin role in the JSON is empty, and the parent levels do not have an admin user to inherit.

500

AEM_USER_ASSIGNED_TO_MULTIPLE_ROLES

User "{userName}" is assigned to multiple roles. Users can only be assigned to a single role.

Returned when a user is assigned to multiple roles.

500

 AEM_GROUP_ASSIGNED_TO_MULTIPLE_ROLES Group "{groupName}" is assigned to multiple roles. Groups can only be assigned to a single role.

Returned when a group is assigned to multiple roles.

500

AEM_USER_GROUP_MULTIPLE_ASSIGNED

"{userName/groupName}" is assigned to multiple roles or to the same role twice. Users/groups can only be assigned once, and to a single role.

Returned either when the specified user already exists as a group in the same/another role, or the specified group already exists as a user in the same/another role.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here