openapi: 3.1.0
info:
  title: Qlik Sense Enterprise Qlik Sense Repository Service API
  description: >-
    Core REST API for managing Qlik Sense Enterprise resources including apps,
    streams, users, security rules, and all configuration available through the
    Qlik Management Console (QMC). The QRS API provides CRUD operations for all
    entity types in the Qlik Sense repository, enabling programmatic
    administration of a Qlik Sense Enterprise 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-repository-service
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 (QPS)
    variables:
      server:
        default: localhost
        description: Qlik Sense server hostname
security:
  - xrfkey: []
  - certificate: []
  - windowsAuth: []
tags:
  - name: About
    description: Retrieve API metadata, version, and schema information
  - name: App
    description: Manage Qlik Sense applications including import, export, copy, publish, and reload
  - name: App Object
    description: Manage application objects such as sheets, stories, and bookmarks
  - name: Content Library
    description: Manage shared and app-specific content libraries
  - name: Custom Property
    description: Manage custom properties for tagging and categorizing entities
  - name: Extension
    description: Manage visualization extensions
  - name: Notification
    description: Subscribe to and manage change notifications
  - name: Reload Task
    description: Manage and execute reload tasks
  - name: Security Rule
    description: Manage security rules and access control
  - name: Server Node
    description: Manage server nodes in a multi-node deployment
  - name: Stream
    description: Manage streams for organizing and distributing apps
  - name: Task
    description: Start and stop tasks including reload and external program tasks
  - name: User
    description: Manage users and user directory synchronization
  - name: User Directory
    description: Manage user directory connectors and synchronization settings
  - name: Virtual Proxy
    description: Manage virtual proxy configurations
paths:
  /about:
    get:
      operationId: getAbout
      summary: Qlik Sense Enterprise Get QRS API information
      description: >-
        Retrieves basic information about the QRS API including the build
        version and the database identifier.
      tags:
        - About
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: QRS API information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AboutInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /about/api/description:
    get:
      operationId: getApiDescription
      summary: Qlik Sense Enterprise Get API endpoint descriptions
      description: >-
        Retrieves a description of all available QRS API endpoints, optionally
        filtered by HTTP method and in an extended format.
      tags:
        - About
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - name: extended
          in: query
          description: Whether to return extended descriptions
          schema:
            type: boolean
            default: false
        - name: method
          in: query
          description: Filter endpoints by HTTP method
          schema:
            type: string
            enum:
              - GET
              - POST
              - PUT
              - DELETE
        - name: format
          in: query
          description: Response format
          schema:
            type: string
            enum:
              - JSON
      responses:
        '200':
          description: API description returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EndpointDescription'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /about/api/default:
    get:
      operationId: getApiDefaults
      summary: Qlik Sense Enterprise Get default values for all entity types
      description: >-
        Retrieves the default values for all entity types in the QRS,
        optionally including list entries.
      tags:
        - About
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - name: listentries
          in: query
          description: Whether to include list entries in the defaults
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Default entity values returned successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
  /about/api/enums:
    get:
      operationId: getApiEnums
      summary: Qlik Sense Enterprise Get enumeration types
      description: >-
        Retrieves all enumeration types used across the QRS API, including
        their allowed values.
      tags:
        - About
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Enumeration types returned successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app:
    get:
      operationId: getApps
      summary: Qlik Sense Enterprise List applications
      description: >-
        Retrieves a list of Qlik Sense applications in condensed format,
        optionally filtered by a query expression.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/OrderByParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of applications returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/full:
    get:
      operationId: getAppsFull
      summary: Qlik Sense Enterprise List applications with full details
      description: >-
        Retrieves a list of Qlik Sense applications in full format including
        all properties, owner, stream, tags, and custom properties.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/OrderByParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Full list of applications returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/App'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/count:
    get:
      operationId: getAppsCount
      summary: Qlik Sense Enterprise Count applications
      description: >-
        Returns the number of applications matching an optional filter
        expression.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Application count returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}:
    get:
      operationId: getApp
      summary: Qlik Sense Enterprise Get application by ID
      description: >-
        Retrieves a single Qlik Sense application by its unique identifier,
        returned in full format.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Application returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateApp
      summary: Qlik Sense Enterprise Update application
      description: >-
        Updates an existing Qlik Sense application. The complete entity
        including the unchanged modifiedDate must be provided in the request
        body.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/App'
      responses:
        '200':
          description: Application updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteApp
      summary: Qlik Sense Enterprise Delete application
      description: >-
        Permanently deletes a Qlik Sense application from the repository.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Application deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/import:
    post:
      operationId: importApp
      summary: Qlik Sense Enterprise Import application
      description: >-
        Imports a Qlik Sense application from a QVF file. The file is uploaded
        as the request body and the application name and other attributes are
        provided as query parameters.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - name: name
          in: query
          required: true
          description: Name for the imported application
          schema:
            type: string
        - name: keepdata
          in: query
          description: Whether to keep the data in the imported app
          schema:
            type: boolean
            default: false
        - name: excludeconnections
          in: query
          description: Whether to exclude data connections from the imported app
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/vnd.qlik.sense.app:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Application imported successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}/copy:
    post:
      operationId: copyApp
      summary: Qlik Sense Enterprise Copy application
      description: >-
        Creates a copy of an existing Qlik Sense application. Requires Read
        and Duplicate permissions on the source application.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - name: name
          in: query
          description: Name for the copied application
          schema:
            type: string
        - name: includecustomproperties
          in: query
          description: Whether to include custom properties in the copy
          schema:
            type: boolean
            default: false
      responses:
        '201':
          description: Application copied successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}/export:
    get:
      operationId: exportApp
      summary: Qlik Sense Enterprise Export application
      description: >-
        Exports a Qlik Sense application as a QVF file. Returns a download
        path that can be used to retrieve the exported file.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - name: skipdata
          in: query
          description: Whether to exclude data from the exported file
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Export download path returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResult'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}/publish:
    put:
      operationId: publishApp
      summary: Qlik Sense Enterprise Publish application to a stream
      description: >-
        Publishes a Qlik Sense application to a specified stream, making it
        available to users with access to that stream.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - name: stream
          in: query
          required: true
          description: ID of the stream to publish the application to
          schema:
            type: string
            format: uuid
        - name: name
          in: query
          description: Optional new name for the published application
          schema:
            type: string
      responses:
        '200':
          description: Application published successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}/reload:
    post:
      operationId: reloadApp
      summary: Qlik Sense Enterprise Reload application data
      description: >-
        Triggers a reload of the application data from its connected data
        sources.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Application reload triggered successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}/replace:
    put:
      operationId: replaceApp
      summary: Qlik Sense Enterprise Replace application content
      description: >-
        Replaces the content of a published application with the content from
        another application, preserving the published app's identity and
        stream membership.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - name: app
          in: query
          required: true
          description: ID of the source application whose content replaces the target
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Application content replaced successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/{id}/migrate:
    put:
      operationId: migrateApp
      summary: Qlik Sense Enterprise Migrate application
      description: >-
        Migrates an application to the current Qlik Sense version format.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Application migrated successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/hublist:
    get:
      operationId: getAppHubList
      summary: Qlik Sense Enterprise Get hub app list
      description: >-
        Retrieves the list of applications available in the hub for the
        authenticated user, including published and personal apps.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Hub application list returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/App'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /app/upload:
    post:
      operationId: uploadApp
      summary: Qlik Sense Enterprise Upload application
      description: >-
        Uploads a Qlik Sense application from a QVF binary file to the
        repository.
      tags:
        - App
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - name: name
          in: query
          required: true
          description: Name for the uploaded application
          schema:
            type: string
        - name: keepdata
          in: query
          description: Whether to keep the data in the uploaded app
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/vnd.qlik.sense.app:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Application uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /appobject/{id}/publish:
    put:
      operationId: publishAppObject
      summary: Qlik Sense Enterprise Publish application object
      description: >-
        Publishes an application object such as a sheet or story, making it
        available to all users who can access the application.
      tags:
        - App Object
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Application object published successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /appobject/{id}/unpublish:
    put:
      operationId: unpublishAppObject
      summary: Qlik Sense Enterprise Unpublish application object
      description: >-
        Unpublishes an application object, reverting it to private status.
      tags:
        - App Object
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Application object unpublished successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream:
    get:
      operationId: getStreams
      summary: Qlik Sense Enterprise List streams
      description: >-
        Retrieves a list of all streams in condensed format, optionally
        filtered by a query expression.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/OrderByParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of streams returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StreamCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createStream
      summary: Qlik Sense Enterprise Create stream
      description: >-
        Creates a new stream for organizing and distributing published
        applications.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Stream'
      responses:
        '201':
          description: Stream created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream/full:
    get:
      operationId: getStreamsFull
      summary: Qlik Sense Enterprise List streams with full details
      description: >-
        Retrieves a list of all streams in full format including owner,
        custom properties, and tags.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/OrderByParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Full list of streams returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Stream'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream/count:
    get:
      operationId: getStreamsCount
      summary: Qlik Sense Enterprise Count streams
      description: Returns the number of streams matching an optional filter expression.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Stream count returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream/{id}:
    get:
      operationId: getStream
      summary: Qlik Sense Enterprise Get stream by ID
      description: Retrieves a single stream by its unique identifier in full format.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Stream returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateStream
      summary: Qlik Sense Enterprise Update stream
      description: >-
        Updates an existing stream. The complete entity with unchanged
        modifiedDate must be provided.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Stream'
      responses:
        '200':
          description: Stream updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteStream
      summary: Qlik Sense Enterprise Delete stream
      description: >-
        Permanently deletes a stream. Published apps in the stream are
        unpublished.
      tags:
        - Stream
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Stream deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /user:
    get:
      operationId: getUsers
      summary: Qlik Sense Enterprise List users
      description: >-
        Retrieves a list of all users in condensed format, optionally filtered
        by a query expression.
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/OrderByParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of users returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /user/full:
    get:
      operationId: getUsersFull
      summary: Qlik Sense Enterprise List users with full details
      description: >-
        Retrieves a list of all users in full format including roles,
        attributes, custom properties, and tags.
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/OrderByParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Full list of users returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /user/count:
    get:
      operationId: getUsersCount
      summary: Qlik Sense Enterprise Count users
      description: Returns the number of users matching an optional filter expression.
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: User count returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /user/{id}:
    get:
      operationId: getUser
      summary: Qlik Sense Enterprise Get user by ID
      description: Retrieves a single user by its unique identifier in full format.
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: User returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateUser
      summary: Qlik Sense Enterprise Update user
      description: >-
        Updates an existing user. The complete entity with unchanged
        modifiedDate must be provided.
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteUser
      summary: Qlik Sense Enterprise Delete user
      description: Permanently deletes a user from the repository.
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: User deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /contentlibrary:
    get:
      operationId: getContentLibraries
      summary: Qlik Sense Enterprise List content libraries
      description: >-
        Retrieves a list of all content libraries in condensed format.
      tags:
        - Content Library
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of content libraries returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContentLibraryCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /contentlibrary/{id}/uploadfile:
    post:
      operationId: uploadContentLibraryFile
      summary: Qlik Sense Enterprise Upload file to content library
      description: >-
        Uploads a file to a content library. The file is sent as the request
        body and the relative path within the library is specified as a query
        parameter.
      tags:
        - Content Library
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - name: externalpath
          in: query
          required: true
          description: Relative path within the content library for the uploaded file
          schema:
            type: string
        - name: overwrite
          in: query
          description: Whether to overwrite an existing file
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: File uploaded successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /contentlibrary/{id}/deletecontent:
    delete:
      operationId: deleteContentLibraryFile
      summary: Qlik Sense Enterprise Delete file from content library
      description: Deletes a file from a content library by its external path.
      tags:
        - Content Library
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
        - name: externalpath
          in: query
          required: true
          description: Relative path of the file to delete within the content library
          schema:
            type: string
      responses:
        '204':
          description: File deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /customproperty:
    get:
      operationId: getCustomProperties
      summary: Qlik Sense Enterprise List custom properties
      description: >-
        Retrieves a list of all custom properties in condensed format.
      tags:
        - Custom Property
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of custom properties returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomPropertyCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCustomProperty
      summary: Qlik Sense Enterprise Create custom property
      description: >-
        Creates a new custom property definition with a set of allowed values
        and applicable object types.
      tags:
        - Custom Property
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomProperty'
      responses:
        '201':
          description: Custom property created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProperty'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /customproperty/{id}:
    get:
      operationId: getCustomProperty
      summary: Qlik Sense Enterprise Get custom property by ID
      description: >-
        Retrieves a single custom property by its unique identifier.
      tags:
        - Custom Property
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Custom property returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProperty'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateCustomProperty
      summary: Qlik Sense Enterprise Update custom property
      description: Updates an existing custom property definition.
      tags:
        - Custom Property
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomProperty'
      responses:
        '200':
          description: Custom property updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProperty'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteCustomProperty
      summary: Qlik Sense Enterprise Delete custom property
      description: Permanently deletes a custom property definition.
      tags:
        - Custom Property
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Custom property deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /extension:
    get:
      operationId: getExtensions
      summary: Qlik Sense Enterprise List extensions
      description: >-
        Retrieves a list of all installed visualization extensions.
      tags:
        - Extension
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of extensions returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExtensionCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /extension/upload:
    post:
      operationId: uploadExtension
      summary: Qlik Sense Enterprise Upload extension
      description: >-
        Uploads and installs a visualization extension from a ZIP file.
      tags:
        - Extension
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/vnd.qlik.sense.app:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Extension uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /extension/{id}:
    get:
      operationId: getExtension
      summary: Qlik Sense Enterprise Get extension by ID
      description: Retrieves a single extension by its unique identifier.
      tags:
        - Extension
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Extension returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteExtension
      summary: Qlik Sense Enterprise Delete extension
      description: Permanently removes a visualization extension.
      tags:
        - Extension
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Extension deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /extension/schema:
    get:
      operationId: getExtensionSchemas
      summary: Qlik Sense Enterprise Get extension schemas
      description: >-
        Retrieves the JSON schemas used to validate extension definitions.
      tags:
        - Extension
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Extension schemas returned successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
  /notification:
    post:
      operationId: createNotificationSubscription
      summary: Qlik Sense Enterprise Subscribe to change notifications
      description: >-
        Creates a subscription to receive notifications when changes occur to
        specified entity types or individual entities.
      tags:
        - Notification
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationSubscription'
      responses:
        '201':
          description: Notification subscription created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: removeNotificationSubscription
      summary: Qlik Sense Enterprise Remove change notification subscription
      description: >-
        Removes an existing notification subscription. The subscription handle
        is passed as a query parameter.
      tags:
        - Notification
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - name: handle
          in: query
          required: true
          description: Handle identifying the notification subscription to remove
          schema:
            type: string
      responses:
        '204':
          description: Subscription removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
  /notification/changes:
    get:
      operationId: getNotificationChanges
      summary: Qlik Sense Enterprise Get changes since last check
      description: >-
        Retrieves a list of changes that have occurred since the last time
        this endpoint was called for the given subscription.
      tags:
        - Notification
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - name: since
          in: query
          description: Timestamp to retrieve changes since
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Change notifications returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChangeNotification'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /reloadtask:
    get:
      operationId: getReloadTasks
      summary: Qlik Sense Enterprise List reload tasks
      description: >-
        Retrieves a list of all reload tasks in condensed format.
      tags:
        - Reload Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of reload tasks returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReloadTaskCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createReloadTask
      summary: Qlik Sense Enterprise Create reload task
      description: Creates a new reload task for an application.
      tags:
        - Reload Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReloadTask'
      responses:
        '201':
          description: Reload task created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReloadTask'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /reloadtask/{id}:
    get:
      operationId: getReloadTask
      summary: Qlik Sense Enterprise Get reload task by ID
      description: >-
        Retrieves a single reload task by its unique identifier.
      tags:
        - Reload Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Reload task returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReloadTask'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateReloadTask
      summary: Qlik Sense Enterprise Update reload task
      description: Updates an existing reload task configuration.
      tags:
        - Reload Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReloadTask'
      responses:
        '200':
          description: Reload task updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReloadTask'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteReloadTask
      summary: Qlik Sense Enterprise Delete reload task
      description: Permanently deletes a reload task.
      tags:
        - Reload Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Reload task deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /securityrule:
    get:
      operationId: getSecurityRules
      summary: Qlik Sense Enterprise List security rules
      description: >-
        Retrieves a list of all security rules in condensed format.
      tags:
        - Security Rule
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of security rules returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityRuleCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createSecurityRule
      summary: Qlik Sense Enterprise Create security rule
      description: >-
        Creates a new security rule that controls access to Qlik Sense
        resources based on conditions.
      tags:
        - Security Rule
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityRule'
      responses:
        '201':
          description: Security rule created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRule'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /securityrule/full:
    get:
      operationId: getSecurityRulesFull
      summary: Qlik Sense Enterprise List security rules with full details
      description: >-
        Retrieves a list of all security rules in full format including the
        rule definition, actions, and resource filter.
      tags:
        - Security Rule
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Full list of security rules returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityRule'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /securityrule/{id}:
    get:
      operationId: getSecurityRule
      summary: Qlik Sense Enterprise Get security rule by ID
      description: Retrieves a single security rule by its unique identifier.
      tags:
        - Security Rule
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Security rule returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRule'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateSecurityRule
      summary: Qlik Sense Enterprise Update security rule
      description: Updates an existing security rule definition.
      tags:
        - Security Rule
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityRule'
      responses:
        '200':
          description: Security rule updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRule'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteSecurityRule
      summary: Qlik Sense Enterprise Delete security rule
      description: Permanently deletes a security rule.
      tags:
        - Security Rule
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Security rule deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /tag:
    get:
      operationId: getTags
      summary: Qlik Sense Enterprise List tags
      description: Retrieves a list of all tags in condensed format.
      tags: []
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of tags returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TagCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createTag
      summary: Qlik Sense Enterprise Create tag
      description: Creates a new tag for categorizing entities.
      tags: []
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tag'
      responses:
        '201':
          description: Tag created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /tag/{id}:
    get:
      operationId: getTag
      summary: Qlik Sense Enterprise Get tag by ID
      description: Retrieves a single tag by its unique identifier.
      tags: []
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Tag returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateTag
      summary: Qlik Sense Enterprise Update tag
      description: Updates an existing tag.
      tags: []
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tag'
      responses:
        '200':
          description: Tag updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteTag
      summary: Qlik Sense Enterprise Delete tag
      description: Permanently deletes a tag.
      tags: []
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Tag deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /task/{id}/start:
    post:
      operationId: startTask
      summary: Qlik Sense Enterprise Start task
      description: >-
        Starts the execution of a task by its ID. This is a synchronous
        operation that waits for the task to be triggered.
      tags:
        - Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Task started successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /task/{id}/start/synchronous:
    post:
      operationId: startTaskSync
      summary: Qlik Sense Enterprise Start task synchronously
      description: >-
        Starts the execution of a task synchronously, waiting for the task
        to reach an end state before returning.
      tags:
        - Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Task completed successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /task/start/many:
    post:
      operationId: startManyTasks
      summary: Qlik Sense Enterprise Start multiple tasks
      description: >-
        Starts the execution of multiple tasks by their IDs.
      tags:
        - Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                format: uuid
              description: Array of task IDs to start
      responses:
        '204':
          description: Tasks started successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
  /task/{id}/stop:
    post:
      operationId: stopTask
      summary: Qlik Sense Enterprise Stop task
      description: Stops the execution of a running task.
      tags:
        - Task
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Task stopped successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /servernodeconfiguration:
    get:
      operationId: getServerNodeConfigurations
      summary: Qlik Sense Enterprise List server node configurations
      description: >-
        Retrieves a list of all server node configurations in condensed format.
      tags:
        - Server Node
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Server node configurations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServerNodeConfigurationCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /servernodeconfiguration/{id}:
    get:
      operationId: getServerNodeConfiguration
      summary: Qlik Sense Enterprise Get server node configuration by ID
      description: >-
        Retrieves a single server node configuration by its unique identifier.
      tags:
        - Server Node
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Server node configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerNodeConfiguration'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /servernodeconfiguration/local:
    get:
      operationId: getLocalServerNodeConfiguration
      summary: Qlik Sense Enterprise Get local server node configuration
      description: >-
        Retrieves the server node configuration for the local node.
      tags:
        - Server Node
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Local server node configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerNodeConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /userdirectory:
    get:
      operationId: getUserDirectories
      summary: Qlik Sense Enterprise List user directories
      description: >-
        Retrieves a list of all configured user directory connectors.
      tags:
        - User Directory
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: User directories returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserDirectoryCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /userdirectory/{id}:
    get:
      operationId: getUserDirectory
      summary: Qlik Sense Enterprise Get user directory by ID
      description: >-
        Retrieves a single user directory connector by its unique identifier.
      tags:
        - User Directory
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: User directory returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDirectory'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteUserDirectory
      summary: Qlik Sense Enterprise Delete user directory and users
      description: >-
        Deletes a user directory connector and optionally all users imported
        from it.
      tags:
        - User Directory
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: User directory deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /userdirectory/syncuserdirectories:
    post:
      operationId: syncUserDirectories
      summary: Qlik Sense Enterprise Synchronize user directories
      description: >-
        Triggers a synchronization of all or specified user directories,
        importing updated user and group information.
      tags:
        - User Directory
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                format: uuid
              description: Array of user directory IDs to synchronize
      responses:
        '204':
          description: Synchronization started successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
  /virtualproxyconfig:
    get:
      operationId: getVirtualProxyConfigs
      summary: Qlik Sense Enterprise List virtual proxy configurations
      description: >-
        Retrieves a list of all virtual proxy configurations.
      tags:
        - Virtual Proxy
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/FilterParam'
        - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Virtual proxy configurations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VirtualProxyConfigCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createVirtualProxyConfig
      summary: Qlik Sense Enterprise Create virtual proxy configuration
      description: >-
        Creates a new virtual proxy configuration with authentication and
        session handling settings.
      tags:
        - Virtual Proxy
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualProxyConfig'
      responses:
        '201':
          description: Virtual proxy configuration created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualProxyConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /virtualproxyconfig/{id}:
    get:
      operationId: getVirtualProxyConfig
      summary: Qlik Sense Enterprise Get virtual proxy configuration by ID
      description: >-
        Retrieves a single virtual proxy configuration by its unique identifier.
      tags:
        - Virtual Proxy
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Virtual proxy configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualProxyConfig'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateVirtualProxyConfig
      summary: Qlik Sense Enterprise Update virtual proxy configuration
      description: Updates an existing virtual proxy configuration.
      tags:
        - Virtual Proxy
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
        - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualProxyConfig'
      responses:
        '200':
          description: Virtual proxy configuration updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualProxyConfig'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /cache:
    delete:
      operationId: invalidateCache
      summary: Qlik Sense Enterprise Invalidate cache
      description: >-
        Invalidates the QRS cache, forcing fresh data retrieval on subsequent
        requests. Use with caution as this impacts performance.
      tags:
        - About
      parameters:
        - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '204':
          description: Cache invalidated successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  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.
    certificate:
      type: mutualTLS
      description: >-
        Client certificate authentication using certificates exported from
        Qlik Sense. Used when connecting directly to QRS on port 4242.
    windowsAuth:
      type: http
      scheme: negotiate
      description: >-
        Windows Integrated Authentication (NTLM/Kerberos) used when
        connecting via the Qlik Sense Proxy Service.
  parameters:
    XrfKeyParam:
      name: Xrfkey
      in: query
      required: true
      description: >-
        Cross-site request forgery prevention key. Must be 16 arbitrary
        characters matching the X-Qlik-Xrfkey header value.
      schema:
        type: string
        minLength: 16
        maxLength: 16
    IdParam:
      name: id
      in: path
      required: true
      description: Unique identifier (GUID) of the entity
      schema:
        type: string
        format: uuid
    FilterParam:
      name: filter
      in: query
      required: false
      description: >-
        Filter expression using the syntax: property operator value. Supports
        operators like eq, ne, so, ew, sw. Example: name eq 'MyApp'
      schema:
        type: string
    OrderByParam:
      name: orderby
      in: query
      required: false
      description: >-
        Property name to order results by, optionally followed by asc or desc.
      schema:
        type: string
    PrivilegesParam:
      name: privileges
      in: query
      required: false
      description: >-
        Whether to append privilege information to the returned entities.
      schema:
        type: boolean
        default: false
  responses:
    BadRequest:
      description: Invalid request. The request body or parameters are malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Authentication failed. The request lacks valid authentication
        credentials or the Xrfkey header/parameter is missing or mismatched.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested entity was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: >-
        Update conflict. The entity has been modified since it was last
        retrieved. Fetch the latest version and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
    EntityCount:
      type: object
      properties:
        value:
          type: integer
          description: Number of entities matching the filter
    AboutInfo:
      type: object
      properties:
        buildVersion:
          type: string
          description: QRS API build version
        buildDate:
          type: string
          description: QRS API build date
        databaseProvider:
          type: string
          description: Database provider used by the repository
        nodeType:
          type: integer
          description: Type of the node (0=Central, 1=Non-central)
        sharedPersistence:
          type: boolean
          description: Whether shared persistence is configured
        requiresBootstrap:
          type: boolean
          description: Whether the node requires bootstrapping
    EndpointDescription:
      type: object
      properties:
        method:
          type: string
          description: HTTP method
        path:
          type: string
          description: Endpoint path
        description:
          type: string
          description: Endpoint description
        parameters:
          type: array
          items:
            type: object
    App:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier
        createdDate:
          type: string
          format: date-time
          description: Date the app was created
        modifiedDate:
          type: string
          format: date-time
          description: Date the app was last modified
        modifiedByUserName:
          type: string
          description: Username of the last modifier
        name:
          type: string
          description: Application name
        appId:
          type: string
          description: Internal application identifier
        description:
          type: string
          description: Application description
        publishTime:
          type: string
          format: date-time
          description: Date the app was published
        published:
          type: boolean
          description: Whether the app is published
        stream:
          $ref: '#/components/schemas/StreamCondensed'
        fileSize:
          type: integer
          format: int64
          description: Size of the application file in bytes
        lastReloadTime:
          type: string
          format: date-time
          description: Date of the last successful reload
        thumbnail:
          type: string
          description: Path to the app thumbnail
        savedInProductVersion:
          type: string
          description: Product version the app was last saved in
        migrationHash:
          type: string
          description: Hash indicating the migration state
        availabilityStatus:
          type: integer
          description: Availability status (0=Normal, 1=Archived)
        owner:
          $ref: '#/components/schemas/UserCondensed'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
          description: Schema path for this entity type
      required:
        - name
    AppCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        appId:
          type: string
        publishTime:
          type: string
          format: date-time
        published:
          type: boolean
        stream:
          $ref: '#/components/schemas/StreamCondensed'
        savedInProductVersion:
          type: string
        migrationHash:
          type: string
        availabilityStatus:
          type: integer
        privileges:
          type: array
          items:
            type: string
    ExportResult:
      type: object
      properties:
        exportToken:
          type: string
          description: Token to use for downloading the exported file
        downloadPath:
          type: string
          description: Relative path to download the exported application file
        schemaPath:
          type: string
    Stream:
      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: Stream name
        owner:
          $ref: '#/components/schemas/UserCondensed'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - name
    StreamCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    User:
      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: Display name of the user
        userDirectory:
          type: string
          description: Name of the user directory the user belongs to
        userId:
          type: string
          description: Unique user ID within the user directory
        roles:
          type: array
          items:
            type: string
          description: Roles assigned to the user
        inactive:
          type: boolean
          description: Whether the user account is inactive
        removedExternally:
          type: boolean
          description: Whether the user was removed from the external directory
        blacklisted:
          type: boolean
          description: Whether the user is blacklisted
        deleteProhibited:
          type: boolean
          description: Whether deletion of the user is prohibited
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - userId
        - userDirectory
    UserCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        userDirectory:
          type: string
        userId:
          type: string
        privileges:
          type: array
          items:
            type: string
    Tag:
      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: Tag name
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - name
    TagCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    CustomProperty:
      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: Custom property name
        valueType:
          type: string
          description: Value type for the custom property
        choiceValues:
          type: array
          items:
            type: string
          description: Allowed values for this custom property
        objectTypes:
          type: array
          items:
            type: string
          description: >-
            Entity types this custom property can be applied to (e.g., App,
            Stream, User)
        description:
          type: string
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - name
    CustomPropertyCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        valueType:
          type: string
        privileges:
          type: array
          items:
            type: string
    CustomPropertyValue:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        definition:
          $ref: '#/components/schemas/CustomPropertyCondensed'
        value:
          type: string
        schemaPath:
          type: string
    ContentLibraryCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    SecurityRule:
      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: Security rule name
        category:
          type: string
          description: Rule category (Security, Sync)
        type:
          type: integer
          description: Rule type
        rule:
          type: string
          description: >-
            Rule definition expression using Qlik Sense security rule syntax
        resourceFilter:
          type: string
          description: >-
            Resource filter expression that defines which resources the rule
            applies to
        actions:
          type: integer
          description: >-
            Bitwise combination of allowed actions (1=Create, 2=Read,
            4=Update, 8=Delete, 16=Export, 32=Publish, 64=Change owner,
            128=Change role)
        comment:
          type: string
          description: Rule description or comment
        disabled:
          type: boolean
          description: Whether the rule is disabled
        ruleContext:
          type: integer
          description: >-
            Context in which the rule applies (0=Both, 1=QMC only, 2=Hub only)
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - name
        - rule
        - resourceFilter
        - actions
    SecurityRuleCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    Extension:
      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: Extension name
        owner:
          $ref: '#/components/schemas/UserCondensed'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - name
    ExtensionCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    ReloadTask:
      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: Reload task name
        taskType:
          type: integer
          description: Task type identifier
        enabled:
          type: boolean
          description: Whether the task is enabled
        taskSessionTimeout:
          type: integer
          description: Task session timeout in minutes
        maxRetries:
          type: integer
          description: Maximum number of retry attempts on failure
        app:
          $ref: '#/components/schemas/AppCondensed'
        isManuallyTriggered:
          type: boolean
          description: Whether the task requires manual triggering
        operational:
          type: object
          properties:
            id:
              type: string
              format: uuid
            lastExecutionResult:
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                executingNodeName:
                  type: string
                status:
                  type: integer
                  description: >-
                    Execution status (0=NeverStarted, 1=Triggered, 2=Started,
                    3=Queued, 4=AbortInitiated, 5=Aborting, 6=Aborted,
                    7=FinishedSuccess, 8=FinishedFail, 9=Skipped, 10=Retry,
                    11=Error, 12=Reset)
                startTime:
                  type: string
                  format: date-time
                stopTime:
                  type: string
                  format: date-time
                duration:
                  type: integer
                  description: Execution duration in milliseconds
            nextExecution:
              type: string
              format: date-time
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
        - name
    ReloadTaskCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        taskType:
          type: integer
        enabled:
          type: boolean
        privileges:
          type: array
          items:
            type: string
    NotificationSubscription:
      type: object
      properties:
        handle:
          type: string
          description: Subscription handle for managing the subscription
        type:
          type: string
          description: Entity type to subscribe to notifications for
        id:
          type: string
          format: uuid
          description: Optional specific entity ID to subscribe to
        condition:
          type: string
          description: Optional filter condition for the subscription
    ChangeNotification:
      type: object
      properties:
        objectType:
          type: string
          description: Type of entity that changed
        objectID:
          type: string
          format: uuid
          description: ID of the entity that changed
        changedProperties:
          type: array
          items:
            type: string
          description: List of properties that were modified
        engineID:
          type: string
        changeType:
          type: string
          description: Type of change (Add, Update, Delete)
    ServerNodeConfiguration:
      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: Node name
        hostName:
          type: string
          description: Hostname of the server node
        isCentral:
          type: boolean
          description: Whether this is the central node
        nodePurpose:
          type: integer
          description: >-
            Purpose of the node (0=Production, 1=Development, 2=Both)
        engineEnabled:
          type: boolean
        proxyEnabled:
          type: boolean
        schedulerEnabled:
          type: boolean
        printingEnabled:
          type: boolean
        failoverCandidate:
          type: boolean
          description: Whether this node can serve as a failover candidate
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
    ServerNodeConfigurationCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        hostName:
          type: string
        isCentral:
          type: boolean
        privileges:
          type: array
          items:
            type: string
    UserDirectory:
      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: User directory name
        type:
          type: string
          description: >-
            User directory connector type (e.g., Active Directory, LDAP)
        configured:
          type: boolean
          description: Whether the user directory is fully configured
        operational:
          type: object
          properties:
            lastSync:
              type: string
              format: date-time
            syncStatus:
              type: integer
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
    UserDirectoryCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        type:
          type: string
        configured:
          type: boolean
        privileges:
          type: array
          items:
            type: string
    VirtualProxyConfig:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        prefix:
          type: string
          description: Virtual proxy prefix used in URLs
        description:
          type: string
          description: Description of the virtual proxy
        authenticationModuleRedirectUri:
          type: string
          format: uri
          description: URI to redirect to for authentication
        sessionModuleBaseUri:
          type: string
          format: uri
          description: Base URI of the session module
        loadBalancingModuleBaseUri:
          type: string
          format: uri
          description: Base URI of the load balancing module
        authenticationMethod:
          type: integer
          description: >-
            Authentication method (0=Ticket, 1=HeaderStaticUserDirectory,
            2=HeaderDynamicUserDirectory, 3=SAML, 4=JWT)
        headerAuthenticationMode:
          type: integer
          description: Header authentication mode
        headerAuthenticationHeaderName:
          type: string
          description: Name of the header used for header-based authentication
        headerAuthenticationStaticUserDirectory:
          type: string
        headerAuthenticationDynamicUserDirectory:
          type: string
        anonymousAccessMode:
          type: integer
          description: Anonymous access mode (0=None, 1=AnonymousAllowed)
        windowsAuthenticationEnabledDevicePattern:
          type: string
        sessionCookieHeaderName:
          type: string
          description: Name of the session cookie header
        sessionCookieDomain:
          type: string
        additionalResponseHeaders:
          type: string
        sessionInactivityTimeout:
          type: integer
          description: Session inactivity timeout in minutes
        extendedSecurityEnvironment:
          type: boolean
        websocketCrossOriginWhiteList:
          type: array
          items:
            type: string
        defaultVirtualProxy:
          type: boolean
          description: Whether this is the default virtual proxy
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
    VirtualProxyConfigCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        prefix:
          type: string
        description:
          type: string
        privileges:
          type: array
          items:
            type: string