Qlik Sense Enterprise User Directory API
Manage user directory connectors and synchronization settings
Qlik Sense Enterprise User Directory 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 Directory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 4 operations across 3 paths, and defines 6 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Qlik Sense Enterprise User Directory 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 4
Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Manage user directory connectors and synchronization settings
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are UserDirectory (12 properties), CustomPropertyValue (7 properties), UserDirectoryCondensed (5 properties), CustomPropertyCondensed (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qlik Sense Enterprise 12
Other APIs Qlik Sense Enterprise publishes across the network.