Qlik Sense Enterprise Access Type API

openapi: 3.1.0
info:
  title: Qlik Sense Enterprise Qlik Sense Service About Access Type API
  description: REST API for retrieving product information about a Qlik Sense site, including system details, installed components, external URLs, and third-party software information. The About Service API provides read-only endpoints that return JSON-formatted information about the Qlik Sense deployment.
  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-about-service
servers:
- url: https://{server}/api/about/v1
  description: About Service API via HTTPS
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
security:
- xrfkey: []
tags:
- name: Access Type
  description: Manage user access types and license allocations
paths:
  /license/accesstypeinfo:
    get:
      operationId: getAccessTypeInfo
      summary: Qlik Sense Enterprise Get access type information
      description: Retrieves information about available access types and their current allocation status, including the total number of tokens or user allocations available and in use.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Access type information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/accesstypeoverview:
    get:
      operationId: getAccessTypeOverview
      summary: Qlik Sense Enterprise Get access type overview
      description: Retrieves an overview of all access types showing total, allocated, available, quarantined, and excess counts for each type.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Access type overview returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeOverview'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/professionalaccesstype:
    get:
      operationId: getProfessionalAccessTypes
      summary: Qlik Sense Enterprise List professional access allocations
      description: Retrieves a list of all professional access type allocations, showing which users have been assigned professional access licenses.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Professional access allocations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccessTypeAllocation'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createProfessionalAccessType
      summary: Qlik Sense Enterprise Allocate professional access
      description: Allocates a professional access license to a specified user.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessTypeAllocationCreate'
      responses:
        '201':
          description: Professional access allocated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeAllocation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/professionalaccesstype/{id}:
    get:
      operationId: getProfessionalAccessType
      summary: Qlik Sense Enterprise Get professional access allocation by ID
      description: Retrieves a single professional access type allocation by its ID.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Professional access allocation returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeAllocation'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteProfessionalAccessType
      summary: Qlik Sense Enterprise Deallocate professional access
      description: Removes a professional access license allocation from a user. The user enters a quarantine period before the license becomes available for reassignment.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Professional access deallocated successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/analyzeraccesstype:
    get:
      operationId: getAnalyzerAccessTypes
      summary: Qlik Sense Enterprise List analyzer access allocations
      description: Retrieves a list of all analyzer access type allocations, showing which users have been assigned analyzer access licenses.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Analyzer access allocations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccessTypeAllocation'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createAnalyzerAccessType
      summary: Qlik Sense Enterprise Allocate analyzer access
      description: Allocates an analyzer access license to a specified user.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessTypeAllocationCreate'
      responses:
        '201':
          description: Analyzer access allocated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeAllocation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/analyzeraccesstype/{id}:
    get:
      operationId: getAnalyzerAccessType
      summary: Qlik Sense Enterprise Get analyzer access allocation by ID
      description: Retrieves a single analyzer access type allocation by its ID.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Analyzer access allocation returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeAllocation'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteAnalyzerAccessType
      summary: Qlik Sense Enterprise Deallocate analyzer access
      description: Removes an analyzer access license allocation from a user.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Analyzer access deallocated successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/loginaccesstype:
    get:
      operationId: getLoginAccessTypes
      summary: Qlik Sense Enterprise List login access allocations
      description: Retrieves a list of all login (token-based) access type allocations.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Login access allocations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LoginAccessAllocation'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/useraccesstype:
    get:
      operationId: getUserAccessTypes
      summary: Qlik Sense Enterprise List user access allocations
      description: Retrieves a list of all named user access type allocations.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: User access allocations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccessTypeAllocation'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createUserAccessType
      summary: Qlik Sense Enterprise Allocate user access
      description: Allocates a named user access license to a specified user.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessTypeAllocationCreate'
      responses:
        '201':
          description: User access allocated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTypeAllocation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /license/useraccesstype/{id}:
    delete:
      operationId: deleteUserAccessType
      summary: Qlik Sense Enterprise Deallocate user access
      description: Removes a named user access license allocation from a user.
      tags:
      - Access Type
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: User access deallocated successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters or body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    FilterParam:
      name: filter
      in: query
      required: false
      description: Filter expression
      schema:
        type: string
    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
  schemas:
    AccessTypeAllocation:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        user:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            userDirectory:
              type: string
            userId:
              type: string
        quarantined:
          type: boolean
          description: Whether the allocation is in quarantine
        quarantineEnd:
          type: string
          format: date-time
          description: When the quarantine period ends
        schemaPath:
          type: string
    AccessTypeInfo:
      type: object
      properties:
        totalTokens:
          type: integer
          description: Total number of tokens available
        availableTokens:
          type: integer
          description: Number of tokens currently available
        usedTokens:
          type: integer
          description: Number of tokens in use
        totalProfessional:
          type: integer
          description: Total professional access licenses
        usedProfessional:
          type: integer
          description: Professional licenses in use
        totalAnalyzer:
          type: integer
          description: Total analyzer access licenses
        usedAnalyzer:
          type: integer
          description: Analyzer licenses in use
    AccessTypeOverview:
      type: object
      properties:
        professional:
          $ref: '#/components/schemas/AccessTypeSummary'
        analyzer:
          $ref: '#/components/schemas/AccessTypeSummary'
        userAccess:
          $ref: '#/components/schemas/AccessTypeSummary'
        loginAccess:
          $ref: '#/components/schemas/AccessTypeSummary'
    AccessTypeAllocationCreate:
      type: object
      properties:
        user:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: User ID to allocate access to
          required:
          - id
      required:
      - user
    AccessTypeSummary:
      type: object
      properties:
        total:
          type: integer
          description: Total licenses of this type
        allocated:
          type: integer
          description: Currently allocated licenses
        available:
          type: integer
          description: Currently available licenses
        quarantined:
          type: integer
          description: Licenses in quarantine period
        excess:
          type: integer
          description: Excess allocations beyond total
    LoginAccessAllocation:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        user:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            userDirectory:
              type: string
            userId:
              type: string
        tokensUsed:
          type: integer
          description: Number of tokens consumed by this login access
        schemaPath:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  securitySchemes:
    xrfkey:
      type: apiKey
      in: header
      name: X-Qlik-Xrfkey
      description: Cross-site request forgery prevention key. Must be 16 arbitrary characters and must match the Xrfkey query parameter.