Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Sense Enterprise User API

Manage proxy sessions by user identity

Qlik Sense Enterprise User API is one of 32 APIs that Qlik Sense Enterprise publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 9 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2025.11.0.

Requests are made against a single base URL, https://{server}/api/about/v1.

9 operations 6 paths 9 schemas 2 DELETE6 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2025.11.0
Server
https://{server}/api/about/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qlik Sense Enterprise User API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Qlik-Xrfkey (xrfkey). By default, every request must be authenticated.

  • xrfkey — Cross-site request forgery prevention key. Must be 16 arbitrary characters and must match the Xrfkey query parameter.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 6 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User 9

Manage proxy sessions by user identity

GET
/user/{userDirectory}/{userId}
Qlik Sense Enterprise Get sessions for a user
getUserSessions 3 params → 200404401
DELETE
/user/{userDirectory}/{userId}
Qlik Sense Enterprise Delete all sessions for a user
deleteUserSessions 3 params → 200404401
GET
/user/{userDirectory}/{userId}/session-count
Qlik Sense Enterprise Get session count for a user
getUserSessionCount 3 params → 200401
GET
/user
Qlik Sense Enterprise List users
getUsers 4 params → 200401
GET
/user/full
Qlik Sense Enterprise List users with full details
getUsersFull 4 params → 200401
GET
/user/count
Qlik Sense Enterprise Count users
getUsersCount 2 params → 200401
GET
/user/{id}
Qlik Sense Enterprise Get user by ID
getUser 3 params → 200404401
PUT
/user/{id}
Qlik Sense Enterprise Update user
updateUser 2 params body → 200404409401
DELETE
/user/{id}
Qlik Sense Enterprise Delete user
deleteUser 2 params → 204404401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (16 properties), Session (7 properties), CustomPropertyValue (7 properties), UserCondensed (5 properties). Each schema is shown below with its type and property counts.

UserCondensed
object
5 properties
SessionAttribute
object
2 properties
User
object
16 properties 2 required
TagCondensed
object
3 properties
Session
object
7 properties
Error
object
1 property
EntityCount
object
1 property
CustomPropertyCondensed
object
4 properties
CustomPropertyValue
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-enterprise-user-api-openapi.yml Raw ↑

Other APIs Qlik Sense Enterprise publishes across the network.

Qlik Sense Engine JSON API
Qlik Sense Capabilities
Qlik Sense Enterprise About API
Qlik Sense Enterprise Access Type API
Qlik Sense Enterprise App API
Qlik Sense Enterprise App Object API
Qlik Sense Enterprise Components API
Qlik Sense Enterprise Content Library API
Qlik Sense Enterprise Custom Property API
Qlik Sense Enterprise Data Connection API
Qlik Sense Enterprise Extension API
Qlik Sense Enterprise External URLs API