License rule audit: Preview audit rules

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

POST

Path

/qrs/systemrule/license/audit/preview

Description

Get a preview of the effect of a license 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

Note: The audit results for all objects are returned, not just for the objects that the auditor has access to. For each object, the name and GUID are returned.

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

-

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?