PutEndpointAcl

General

URL

https://{host}/attunityenterprisemanager/api/v1/servers/{server}/endpoints/{endpoint}?action=acl

Description

Sets an explicit ACL for a specific endpoint 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 endpoint should inherit ACLs from its ancestors (in addition to its explicitly defined ACLs) or not.

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

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

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 endpoint; 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 MyEndpoint and user A is also defined as an Admin on All Endpoints, then user A will be defined as an Admin on All Endpoints but as a Viewer on MyEndpoint.

HTTP method

PUT

Required user role

See Required Enterprise Manager permissions.

Request parameters

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 endpoint.

    • name: A single Admin user.

  • groups: An array of groups assigned as Admins on the endpoint.

    • name: A single Admin group.

• designer_role

  • users: An array of users assigned as Designers on the endpoint.

    • name: A single Designer user.

  • groups: An array of groups assigned as Designers on the endpoint.

    • name: A single Designer group.

• operator_role

  • users: An array of users assigned as Operators on the endpoint.

    • name: A single Operator user.

  • groups: An array of groups assigned as Operators on the endpoint.

    • name: A single Operator group.

• viewer_role

  • users: An array of users assigned as Viewers on the endpoint.

    • name: A single Viewer user.

  • groups: An array of groups assigned as Viewers on the endpoint.

    • name: A single Viewer group.

• disable_inheritance: If set to "true", the endpoint does not inherit ACLs from its ancestors (in addition to its explicit ACLs). If set to "false", the endpoint inherits ACLs from its ancestors, in addition to any explicit ACLs.

Example 4: Add a user with None permission to a specific endpoint

Replace the placeholders before running the commands:

• https://{host}
• <SESSION_ID>
• <Server Name>, and <Endpoint Name>
• domain\\existing_user and domain\\new_user

PUT

Verify (GET)

Error response

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