Qlik Sense Enterprise License Audit API

openapi: 3.2.0
info:
  title: Qlik Sense Enterprise Qlik Sense Licenses License Audit API
  description: REST API endpoints within the Qlik Sense Repository Service for managing licenses, license allocations, and user access types in Qlik Sense Enterprise. This API enables programmatic management of license enablement files (LEF), access type rules, and user license assignments including Professional, Analyzer, and Token access types.
  version: 2025.11.0
  contact:
    name: Qlik Support
    url: https://community.qlik.com/
  license:
    name: Proprietary
    url: https://www.qlik.com/us/legal/terms-of-use
  x-providerName: Qlik
  x-serviceName: qlik-sense-licenses
servers:
- url: https://{server}:4242/qrs
  description: Direct QRS connection via certificate authentication
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
- url: https://{server}/qrs
  description: QRS connection via Qlik Sense Proxy Service
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
security:
- xrfkey: []
- certificate: []
tags:
- name: License Audit
  description: Audit license rule evaluations and access type assignments
paths:
  /licenserule/audit:
    post:
      operationId: auditLicenseRules
      summary: Qlik Sense Enterprise Audit license rules
      description: Evaluates license rules to determine which access types would be assigned to users based on the current rule configuration.
      tags:
      - License Audit
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LicenseAuditRequest'
      responses:
        '200':
          description: License rule audit results returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseAuditResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    LicenseAuditRequest:
      type: object
      properties:
        resourceType:
          type: string
          description: Type of resource to audit
        resourceFilter:
          type: string
          description: Filter for resources
        userFilter:
          type: string
          description: Filter for users
    LicenseAuditResult:
      type: object
      properties:
        matrix:
          type: array
          items:
            type: object
          description: Audit result matrix showing rule evaluations
        schemaPath:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  parameters:
    XrfKeyParam:
      name: Xrfkey
      in: query
      required: true
      description: Cross-site request forgery prevention key matching the X-Qlik-Xrfkey header.
      schema:
        type: string
        minLength: 16
        maxLength: 16
  responses:
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    xrfkey:
      type: apiKey
      in: header
      name: X-Qlik-Xrfkey
      description: Cross-site request forgery prevention key. Must be 16 arbitrary characters.
    certificate:
      type: mutualTLS
      description: Client certificate authentication for direct QRS access on port 4242.