Qlik Sense Enterprise License Rule API

openapi: 3.2.0
info:
  title: Qlik Sense Enterprise Qlik Sense Licenses License Rule 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 Rule
  description: Manage license rules that control automatic license assignment
paths:
  /licenserule:
    get:
      operationId: getLicenseRules
      summary: Qlik Sense Enterprise List license rules
      description: Retrieves a list of all license rules that control automatic license assignment based on user properties and conditions.
      tags:
      - License Rule
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: License rules returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LicenseRule'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /licenserule/full:
    get:
      operationId: getLicenseRulesFull
      summary: Qlik Sense Enterprise List license rules with full details
      description: Retrieves a list of all license rules in full format including rule definitions and actions.
      tags:
      - License Rule
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Full license rules returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LicenseRule'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /licenserule/{id}:
    get:
      operationId: getLicenseRule
      summary: Qlik Sense Enterprise Get license rule by ID
      description: Retrieves a single license rule by its unique identifier.
      tags:
      - License Rule
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: License rule returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseRule'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    LicenseRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        name:
          type: string
          description: License rule name
        category:
          type: string
          description: Rule category
        type:
          type: integer
          description: Rule type
        rule:
          type: string
          description: Rule definition expression
        resourceFilter:
          type: string
          description: Resource filter expression
        actions:
          type: integer
          description: Allowed actions (bitwise)
        comment:
          type: string
          description: Rule description
        disabled:
          type: boolean
          description: Whether the rule is disabled
        schemaPath:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      description: Unique identifier (GUID) of the entity
      schema:
        type: string
        format: uuid
    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
    FilterParam:
      name: filter
      in: query
      required: false
      description: Filter expression
      schema:
        type: string
  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.