Security rule audit: Get audit preview

Method

POST

Path

/qrs/systemrule/security/audit/preview

Description

Get a preview of the effect of a system rule based on resource type, a selection of users, and a selection of resources before the rule is added in Qlik Sense.

Body

AuditPreviewParameters:
{
   "resourceType": "App" // or any type at all,
   "ResourceFilter": "resource filter [string]",
   "UserFilter": "user filter [string]",
   "EnvironmentAttributes": "type1=value1;type2=value2",
   "RuleConditions": a rule,
   "Actions": what the user is allowed to do
   "userSkip": "count [integer]",
   "userTake": "count [integer]",
   "resourceSkip": "count [integer]",
   "resourceTake": "count [integer]"
}

The environmentAttributes type is one (or several, separated by “;”) of the following:

• OS
• Device
• Browser
• RequestType
• IP

Return value

AuditPreviewResult:

{
   "users": {
      "[GUID]": { // A user object
         "userId": "…",
         "userDirectory": "…",
         "name": "…",
         …
      },
      "[GUID]": { … }
   },
   "resources": {
      "[GUID]": { // An object of arbitrary type
         "…",
      },
      "[GUID]": { … }
   },
   "rules": {
      "[GUID]": { // Security rule object
         "type": "…",
         "name": "…",
         "rule": "…",
         "resourceFilter": "…",
         …
      },
      "[GUID]": { … }
   },
   "ruleApplication": [
      {
         "userID": "[GUID]",
         "resourceID": "[GUID]",
         "ruleID": "[GUID]",
         "allowed": boolean,
         "errorAt": integer,
         "errorMessage": "…",
         "evaluationState": "evaluated/parsefailure/evaluationfailure"
      },
      { … }
   ]
}

Optional parameters

-