GetEndpointsCollectionAcl
Retrieves a list of users/groups with permissions on all endpoints, including a boolean indication if ACL inheritance is disabled or enabled for each endpoint.
The method returns the explicit ACL only. In other words, it does not return inherited ACLs.
If all of the endpoints' ACLs are inherited (that is, no ACL was explicitly defined for any of the endpoints), an error will be returned indicating that no ACL was found.
This method can be used together with PutEndpointsCollectionAcl in order to update an existing endpoint's ACL. First call GetEndpointsCollectionAcl, then edit the returned roles as required, and finally, call PutEndpointsCollectionAcl.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public AemAuthorizationAcl GeteEndpointsCollectionAcl(
string server
);
Parameters
| Parameter | Type | Description |
| server | string | The name of the server where the endpoints are located. |
Return values
AemAuthorizationAcl
| Parameter | Type | Description |
|
DisableInheritance |
bool |
If set to "true", the endpoint 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 | Message | Description |
|
AEM_GET_ENDPOINT_ACL_INNER_ERR |
Failed to get ACL of endpoint "{endpoint}". Error: "{message}". |
Returned if Qlik Enterprise Manager encounters an error/exception when trying to get the endpoint ACL. |
|
AEM_ENDPOINT_HAS_NO_ACL |
ACL for endpoint "{endpoint}" could not be found. |
Returned if no explicit ACL is defined for the endpoint. Information note
A endpoint that does not have its own explicit ACL inherits the ACL from its ancestors. Inherited ACLs are not returned by this method. |