{ "opencollection": "1.0.0", "info": { "name": "Qlik Sense Enterprise Qlik Sense Service About User API", "version": "2025.11.0" }, "request": { "auth": { "type": "apikey", "key": "X-Qlik-Xrfkey", "value": "{{X-Qlik-Xrfkey}}", "placement": "header" } }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Qlik Sense Enterprise Get sessions for a user", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/about/v1/user/:userDirectory/:userId", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "userDirectory", "value": "", "type": "path", "description": "Name of the user directory the user belongs to" }, { "name": "userId", "value": "", "type": "path", "description": "User identifier within the user directory" } ] }, "docs": "Retrieves all active sessions for a specific user identified by their user directory and user ID." }, { "info": { "name": "Qlik Sense Enterprise Delete all sessions for a user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/about/v1/user/:userDirectory/:userId", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "userDirectory", "value": "", "type": "path", "description": "Name of the user directory" }, { "name": "userId", "value": "", "type": "path", "description": "User identifier within the user directory" } ] }, "docs": "Deletes all active sessions for a specific user, effectively logging the user out of all Qlik Sense connections." }, { "info": { "name": "Qlik Sense Enterprise Get session count for a user", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/about/v1/user/:userDirectory/:userId/session-count", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "userDirectory", "value": "", "type": "path", "description": "Name of the user directory" }, { "name": "userId", "value": "", "type": "path", "description": "User identifier within the user directory" } ] }, "docs": "Returns the number of active sessions for a specific user." }, { "info": { "name": "Qlik Sense Enterprise List users", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/about/v1/user", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression using the syntax: property operator value. Supports operators like eq, ne, so, ew, sw. Example: name eq 'MyApp'" }, { "name": "orderby", "value": "", "type": "query", "description": "Property name to order results by, optionally followed by asc or desc." }, { "name": "privileges", "value": "", "type": "query", "description": "Whether to append privilege information to the returned entities." } ] }, "docs": "Retrieves a list of all users in condensed format, optionally filtered by a query expression." }, { "info": { "name": "Qlik Sense Enterprise List users with full details", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/about/v1/user/full", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression using the syntax: property operator value. Supports operators like eq, ne, so, ew, sw. Example: name eq 'MyApp'" }, { "name": "orderby", "value": "", "type": "query", "description": "Property name to order results by, optionally followed by asc or desc." }, { "name": "privileges", "value": "", "type": "query", "description": "Whether to append privilege information to the returned entities." } ] }, "docs": "Retrieves a list of all users in full format including roles, attributes, custom properties, and tags." }, { "info": { "name": "Qlik Sense Enterprise Count users", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/about/v1/user/count", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression using the syntax: property operator value. Supports operators like eq, ne, so, ew, sw. Example: name eq 'MyApp'" } ] }, "docs": "Returns the number of users matching an optional filter expression." }, { "info": { "name": "Qlik Sense Enterprise Get user by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/about/v1/user/:id", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "id", "value": "", "type": "path", "description": "Unique identifier (GUID) of the entity" }, { "name": "privileges", "value": "", "type": "query", "description": "Whether to append privilege information to the returned entities." } ] }, "docs": "Retrieves a single user by its unique identifier in full format." }, { "info": { "name": "Qlik Sense Enterprise Update user", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/about/v1/user/:id", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "id", "value": "", "type": "path", "description": "Unique identifier (GUID) of the entity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing user. The complete entity with unchanged modifiedDate must be provided." }, { "info": { "name": "Qlik Sense Enterprise Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/about/v1/user/:id", "params": [ { "name": "Xrfkey", "value": "", "type": "query", "description": "Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value." }, { "name": "id", "value": "", "type": "path", "description": "Unique identifier (GUID) of the entity" } ] }, "docs": "Permanently deletes a user from the repository." } ] } ], "bundled": true }