Skip to main content Skip to complementary content

GetServerAcl

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 server ACLs are inherited (i.e. 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 AemPutServerAcl in order to update an existing server's ACL. First, call AemGetServerAcl, then edit the returned roles as required, and finally, call AemPutServerAcl.

Required User Role: See Required Enterprise Manager permissions.

Syntax

public AemAuthorizationAcl GetServerAcl(

string server

);

Parameters

Parameters
Parameter Type Description
server string The name of the server where the ACL is located.

Return values

AemAuthorizationAcl

Return values
Parameter Type Description

DisableInheritance

bool

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.

AdminRole

AemRoleDef

Users and/or groups assigned as Admin role.

DesignerRole

AemRoleDef

Users and/or groups assigned as Designer role.

OperatorRole

AemRoleDef

Users and/or groups assigned as Operator role.

ViewerRole

AemRoleDef

Users and/or groups assigned as Viewer role.

Groups

List<AemGroupRef>

Groups assigned as the role.

Name

string

The group name.

Users

List<AemUserRef>

Users assigned as the role.

Name

string

The user name.

Errors

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

Error responses
Error Message Description

AEM_GET_SERVER_ACL_INNER_ERR

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

Error: "{message}".

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

AEM_SERVER_HAS_NO_ACL

ACL for server "{server}" could not be found.

Returned if no explicit ACL is defined for the server.

Information note

A server that does not have its own explicit ACL inherits the ACL from its ancestors. Inherited ACLs are not returned by this method.

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!