GetTaskAcl
Retrieves the explicit ACL defined in Qlik Enterprise Manager for the specified task, including a Boolean indication if ACL inheritance is disabled or enabled for the task.
The method returns the explicit ACL only. In other words, it does not return inherited ACLs.
If all of the task ACLs are inherited (i.e. no ACL was explicitly defined for the task), an error will be returned indicating that no ACL was found.
This method can be used together with PutTaskAcl in order to update an existing server's ACL. First, call GetTaskAcl, then edit the returned roles as required, and finally, call PutTaskAcl.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public AemAuthorizationAcl GetTaskAcl(
string server
string task
);
Parameters
| Parameter | Type | Description |
| server | string | The name of the server where the task ACL is located. |
| task | string | The name of the task whose ACL you want to retrieve. |
Return values
AemAuthorizationAcl
| Parameter | Type | Description |
|
DisableInheritance |
bool |
If set to "true", the task does not inherit ACLs from its ancestors (in addition to its explicit ACLs). If set to "false", the task 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. |
|
NoneRole |
AemRoleDef |
Users and/or groups without a 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_TASK_ACL_INNER_ERR |
Failed to get ACL of task "{task}". Error: "{message}". |
Returned if Qlik Enterprise Manager encounters an error/exception when trying to get the task ACL. |
|
AEM_TASK_HAS_NO_ACL |
ACL for task "{task}" could not be found. |
Returned if no explicit ACL is defined for the task. Information note
A task that does not have its own explicit ACL inherits the ACL from its ancestors. Inherited ACLs are not returned by this method. |