> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Qlik

> How to set up the Qlik connector, plus the actions and events that are available.

![Qlik](https://stackone-logos.com/api/qlik/filled/svg)

v3.0.0[See changelog](https://docs.stackone.com/connectors/qlik/changelog.md)

[112 actions](#actions) · [20 events](#events) · 3 auth methods

Analytics
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/qlik/guides/connector-profile/oauth-2-0.md)
>
> Connect using OAuth 2.0 authorization code flow for user-delegated access to Qlik Cloud resources.

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/qlik/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Machine-to-machine access with no signed-in user. Qlik creates a bot user for the OAuth client on its first token reques...

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/qlik/guides/connector-profile/api-key.md)
>
> Authenticate using a Qlik Cloud API key. API keys provide the same permissions as the user who created them. Keys cannot...

Optionally, configure receiving Events for Qlik into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/qlik/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/qlik/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/qlik/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/qlik/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

OAuth 2.0 (Client Credentials)

No auth methods found

Scopes

Select all
|
Clear

admin.automations

admin.automations:read

admin.collections.publicgoverned

admin.extensions

admin.spaces

admin.spaces:read

admin.themes

admin.users

admin.users:read

apps

apps:read

spaces.shared:create

users:read

No scopes found

112 actions

ActionDescriptionRequired scopes

List API Keys`qlik_list_api_keys`

Lists API keys for the tenant with cursor-based pagination

Create API Key`qlik_create_api_key`

Creates an API key for a user or for configuring SCIM. SCIM keys do not accept 'expiry' field.

Get API Key`qlik_get_api_key`

Returns an API key for a given ID

Delete API Key`qlik_delete_api_key`

Deletes or revokes an API key

Update API Key Description`qlik_update_api_key_description`

Updates an API key description using JSON Patch operations

Get API Keys Configuration`qlik_get_api_keys_config`

Retrieves the API key configuration for a tenant

Update API Keys Configuration`qlik_update_api_keys_config`

Updates the API keys configuration for a tenant using JSON Patch operations. max\_keys\_per\_user requires a number value.

List Audit Events`qlik_list_audit_events`

Retrieves list of events for subscribed services for your tenant. Stores events for 90 days, after which they can be acc...

Get Audit Event`qlik_get_audit_event`

Finds and returns a specific audit events for the given event ID.

List Archived Audit Events`qlik_list_archived_audit_events`

Retrieves audit events from long-term storage. Returns all archived audit events for the specified date and tenant, form...

Get Audit Settings`qlik_get_audit_settings`

Returns the server configuration options. It includes options that represent the server configuration state and paramete...

List Audit Sources`qlik_list_audit_sources`

Finds and returns the list of possible event sources for this tenant.

List Audit Event Types`qlik_list_audit_event_types`

Finds and returns the list of possible event types for this tenant.

List Automations`qlik_list_automations`

Retrieves a list of the automations that the requesting user has access to. Filter uses SCIM syntax (e.g. name eq "value...

`admin.automations:read`

Get Automation`qlik_get_automation`

Retrieves the full definition of an automation. The requesting user must be the owner of the automation.

`admin.automations:read`

Create Automation`qlik_create_automation`

Creates a new automation. The requesting user must be assigned the `AutomationCreator` role.

`admin.automations`

Update Automation`qlik_update_automation`

Updates the full definition of an automation. Requires ownership or TenantAdmin role.

`admin.automations`

Delete Automation`qlik_delete_automation`

Deletes an automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.

`admin.automations`

Change Automation Owner`qlik_change_automation_owner`

Changes the owner of an automation to another user. This action removes the history and change logs of this automation....

`admin.automations`

Change Automation Space`qlik_change_automation_space`

Changes the space of an automation by specifying a new space.

`admin.automations`

Duplicate Automation`qlik_copy_automation`

Duplicates an existing automation. The requesting user must be the owner of the automation.

`admin.automations`

Disable Automation`qlik_disable_automation`

Disables an automation so that it cannot be run. The requesting user must be the owner of the automation, or be assigned...

`admin.automations`

Enable Automation`qlik_enable_automation`

Enables an automation so that it can be run. The requesting user must be the owner of the automation, or be assigned the...

`admin.automations`

Move Automation`qlik_move_automation`

Changes the owner of an automation to another user. This action removes the history and change logs of this automation....

`admin.automations`

List Automation Runs`qlik_list_automation_runs`

Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assig...

`admin.automations:read`

Run Automation`qlik_create_automation_run`

Creates a runs for a specific automation. The requesting user must be the owner of the automation.

`admin.automations`

Get Automation Run`qlik_get_automation_run`

Retrieves a specific run for an automation. The requesting user must be the owner of the automation.

`admin.automations:read`

Export Automation Run Log`qlik_export_automation_run_log`

Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automatio...

`admin.automations:read`

Retry Automation Run`qlik_retry_automation_run`

Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automat...

`admin.automations`

Stop Automation Run`qlik_stop_automation_run`

Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.

`admin.automations`

Get Automation Usage Metrics`qlik_get_automation_usage_metrics`

Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` role.

`admin.automations:read`

List Brands`qlik_list_brands`

List brands

`admin.themes`

Get Brand`qlik_get_brand`

Retrieve a brand

`admin.themes`

Update Brand`qlik_update_brand`

Update a brand

`admin.themes`

Delete Brand`qlik_delete_brand`

Delete a brand

`admin.themes`

Activate Brand`qlik_activate_brand`

Activate a brand

`admin.themes`

Deactivate Brand`qlik_deactivate_brand`

Deactivate a brand

`admin.themes`

Get Brand File`qlik_get_brand_file`

Download brand file

`admin.themes`

Delete Brand File`qlik_delete_brand_file`

Delete a brand file

`admin.themes`

Get Active Brand`qlik_get_active_brand`

Retrieve active brand

`admin.themes`

List Collections`qlik_list_collections`

Retrieves the collections that the user has access to

`apps:read`

Create Collection`qlik_create_collection`

Creates and returns a new collection

`admin.collections.publicgoverned`

Get Collection`qlik_get_collection`

Finds and returns a collection

`apps:read`

Update Collection`qlik_update_collection`

Updates a collection's name and description

`admin.collections.publicgoverned`

Delete Collection`qlik_delete_collection`

Deletes a collection and removes all items from the collection

`admin.collections.publicgoverned`

List Items In A Collection`qlik_list_collection_items`

Retrieves items from a collection that the user has access to

`apps:read`

Add Item To Collection`qlik_add_item_to_collection`

Adds an item to a collection and returns the item

`admin.collections.publicgoverned`

Get An Item`qlik_get_collection_item`

Finds and returns an item in a specific collection

`apps:read`

Remove An Item`qlik_remove_item_from_collection`

Removes an item from a collection

`admin.collections.publicgoverned`

Get User's Favorites Collection`qlik_get_favorites_collection`

Lists the user's favorites collection

`apps:read`

List Extensions`qlik_list_extensions`

List all extensions

`admin.extensions`

Get Extension`qlik_get_extension`

Get a specific extension

`admin.extensions`

Delete Extension`qlik_delete_extension`

Delete a specific extension

`admin.extensions`

Get Extension Archive`qlik_get_extension_archive`

Download extension as an archive

`admin.extensions`

Get Extension File`qlik_get_extension_file`

Download file from extension archive

`admin.extensions`

List Groups`qlik_list_groups`

Returns a list of groups with cursor-based pagination

Create Group`qlik_create_group`

Creates a new group

Get Group`qlik_get_group`

Returns the requested group

Update Group`qlik_update_group`

Updates the requested group

Delete Group`qlik_delete_group`

Deletes the requested group

Filter Groups`qlik_filter_groups`

Retrieves a list of groups matching the filter using advanced query string

Get Group Settings`qlik_get_group_settings`

Returns the tenant's group settings

Get Unified Credentials`qlik_unified_get_me`

Return the authenticated identity and auth type for the current Qlik Cloud connection. Fetches /users/me and inlines the...

`users:read`

List Unified Groups`qlik_unified_list_groups`

List all Qlik Cloud groups (regular plus system groups like com.qlik.Everyone) from GET /groups, mapped to the StackOne...

`admin.users:read`

Get Unified Group`qlik_unified_get_group`

Retrieve a single Qlik Cloud group by its unique ID, mapped to the StackOne IAM unified group schema. Supports expand=ro...

`admin.users:read`

List Unified Organizations`qlik_unified_list_organizations`

List the single Qlik Cloud tenant associated with this connection, mapped to the StackOne IAM unified organization schem...

`users:read`

Get Unified Organization`qlik_unified_get_organization`

Retrieve the single Qlik Cloud tenant associated with this connection, mapped to the StackOne IAM unified organization s...

`users:read`

List Unified Resource Types`qlik_unified_list_resource_types`

Returns the Qlik Cloud resource types that support resource-scoped permission queries via unified\_list\_resource\_users.

`users:read`

List Unified Resource Users`qlik_unified_list_resource_users`

List users, groups, and bots that hold assignments on a Qlik Cloud space, mapped to the unified IamUser schema with reso...

`admin.spaces:read`

List Unified Roles`qlik_unified_list_roles`

List all Qlik Cloud roles from GET /roles, mapped to the StackOne IAM unified role schema. Returns role identity, type (...

`admin.users:read`

Get Unified Role`qlik_unified_get_role`

Retrieve a single Qlik Cloud role by its unique ID, mapped to the StackOne IAM unified role schema. Returns role identit...

`admin.users:read`

List Unified Users`qlik_unified_list_users`

List all Qlik Cloud users from GET /users, mapped to the StackOne IAM unified user schema. Returns identity, enabled/dis...

`admin.users:read`

Get Unified User`qlik_unified_get_user`

Retrieve a single Qlik Cloud user by their unique ID, mapped to the StackOne IAM unified user schema. expand=roles retur...

`admin.users:read`

List Items`qlik_list_items`

Lists catalog items (apps, datasets, automations, and other resources) that the user has access to

`apps:read`

Get Item`qlik_get_item`

Finds and returns an item

`apps:read`

Update Item`qlik_update_item`

Updates an item

`apps`

Delete Item`qlik_delete_item`

Deletes an item and removes the item from all collections

`apps`

List Collections Of An Item`qlik_list_item_collections`

Finds and returns the collections (and tags) of an item

`apps:read`

Get Items Settings`qlik_get_items_settings`

Finds and returns the items service settings for the current tenant

`apps:read`

List Roles`qlik_list_roles`

Returns a list of roles using cursor-based pagination

Create Role`qlik_create_role`

Creates a custom role

Get Role`qlik_get_role`

Returns the requested role

Update Role`qlik_update_role`

Updates the requested role

Delete Role`qlik_delete_role`

Deletes the requested role

List Spaces`qlik_list_spaces`

Retrieves spaces that the current user has access to and match the query

`admin.spaces:read`

Create Space`qlik_create_space`

Creates a space

`spaces.shared:create`

Get Space`qlik_get_space`

Retrieves a single space by ID

`admin.spaces:read`

Update Space`qlik_update_space`

Updates a space

`admin.spaces`

Delete Space`qlik_delete_space`

Deletes a space

`admin.spaces`

List Assignments For A Space`qlik_list_space_assignments`

Retrieves the assignments of the space matching the query

`admin.spaces:read`

Assign User Or Group To A Space`qlik_create_space_assignment`

Creates an assignment for a user or group (assignee) to a space with the specified roles. Returns 409 if assignment alre...

`admin.spaces`

Retrieve An Assignment For A Space`qlik_get_space_assignment`

Retrieves a single assignment by assignment ID

`admin.spaces:read`

Update An Assignment For A Space`qlik_update_space_assignment`

Updates a single assignment by assignment ID

`admin.spaces`

Delete An Assignment`qlik_delete_space_assignment`

Deletes an assignment

`admin.spaces`

List Space Shares`qlik_list_space_shares`

Retrieves the shares of the space matching the query

`admin.spaces:read`

Create A Space Share`qlik_create_space_share`

Creates a share

`admin.spaces`

Retrieve A Space Share`qlik_get_space_share`

Retrieves a single space share by ID

`admin.spaces:read`

Delete A Space Share`qlik_delete_space_share`

Deletes a space share

`admin.spaces`

List Space Types`qlik_list_space_types`

Gets a list of distinct space types available for use in the tenant

`admin.spaces:read`

List Tasks`qlik_list_tasks`

List tasks

Get Task`qlik_get_task`

Get a task

Delete Task`qlik_delete_task`

Delete a task

Start Task`qlik_start_task`

Start a task

List Users`qlik_list_users`

Retrieve a paginated list of users in the Qlik Cloud tenant

`admin.users:read`

Get User`qlik_get_user`

Retrieve details of a specific user by ID

`admin.users:read`

Get Current User`qlik_get_current_user`

Retrieve the currently authenticated user's profile. Returns 301 redirect with user ID if non-tenant-specific base URL i...

`users:read`

Create User`qlik_create_user`

Create a new user in the Qlik Cloud tenant

`admin.users`

Update User`qlik_update_user`

Update fields for a user by ID using JSON Patch operations. Use 'replace' for assignedRoles and status (not 'add' or 'se...

`admin.users`

Delete User`qlik_delete_user`

Delete a user from the Qlik Cloud tenant

`admin.users`

Count Users`qlik_count_users`

Get the total count of users in the tenant

`admin.users:read`

Filter Users`qlik_filter_users`

Filter users using POST-body SCIM filter criteria. Use this instead of list\_users when the filter is complex or long.

`admin.users:read`

Invite Users`qlik_invite_user`

Send invitation emails to new users

`admin.users`

## Events

Tags

Select all
|
Clear

API Keys

Apps

Automations

Tasks

Users

Webhooks

No tags found

20 events

EventDescriptionTags

API Key Validation Failed`qlik_webhook_api_key_validation_failed`

Processes events fired when validation of an API key fails.

API KeysWebhooks

App Created`qlik_webhook_app_created`

Processes events fired when an app is created.

AppsWebhooks

App Data Updated`qlik_webhook_app_data_updated`

Processes events fired when an app's data is updated.

AppsWebhooks

App Deleted`qlik_webhook_app_deleted`

Processes events fired when an app is deleted.

AppsWebhooks

App Exported`qlik_webhook_app_exported`

Processes events fired when an app is exported.

AppsWebhooks

App Published`qlik_webhook_app_published`

Processes events fired when an app is published to a managed space.

AppsWebhooks

App Reload Finished`qlik_webhook_app_reload_finished`

Processes events fired when an app reload finishes, whether it succeeded or failed.

AppsWebhooks

Automation Created`qlik_webhook_automation_created`

Processes events fired when an automation is created.

AutomationsWebhooks

Automation Deleted`qlik_webhook_automation_deleted`

Processes events fired when an automation is deleted.

AutomationsWebhooks

Automation Updated`qlik_webhook_automation_updated`

Processes events fired when an automation is updated.

AutomationsWebhooks

Automation Run Started`qlik_webhook_automation_run_started`

Processes events fired when an automation run starts.

AutomationsWebhooks

Automation Run Ended`qlik_webhook_automation_run_ended`

Processes events fired when an automation run ends.

AutomationsWebhooks

Automation Run Failed`qlik_webhook_automation_run_failed`

Processes events fired when an automation run fails.

AutomationsWebhooks

Data Integration Task Started`qlik_webhook_di_task_started`

Processes events fired when a data integration task starts.

TasksWebhooks

Data Integration Task Completed`qlik_webhook_di_task_completed`

Processes events fired when a data integration task completes.

TasksWebhooks

Data Integration Task Failed`qlik_webhook_di_task_failed`

Processes events fired when a data integration task fails.

TasksWebhooks

Data Integration Task Stopped`qlik_webhook_di_task_stopped`

Processes events fired when a data integration task is stopped.

TasksWebhooks

Reload Finished`qlik_webhook_reload_finished`

Processes events fired when a reload finishes.

TasksWebhooks

User Created`qlik_webhook_user_created`

Processes events fired when a user is created.

UsersWebhooks

User Deleted`qlik_webhook_user_deleted`

Processes events fired when a user is deleted.

UsersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.