Skip to main content

Qlik Cloud

Lets agents list and reload Qlik Sense apps, read spaces and data files, and automate a Qlik Cloud tenant.

Connect it with: API key. Qlik Cloud's own documentation: https://qlik.dev/authenticate/api-key/generate-your-first-api-key/.

What agents can do​

Connect Qlik Cloud so the agents working your tasks can reach it. With it connected, they can:

  • List apps, spaces and data files, and read app metadata.
  • Reload an app and check the reload's status and log.
  • Run and monitor Qlik Automate automations.
  • Manage users, groups and space membership with an admin's key.

Before you start​

  • A Qlik Cloud tenant and its address.
  • A Tenant Admin who turns on API keys: Administration > Settings > API keys > Enable API keys, and sets the maximum key lifetime.
  • The Developer role (or a custom role with the Manage API keys permission) for the user who generates the key.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Qlik Cloud​

Jaah connects to Qlik Cloud with an API key, not with a sign-in button.

Connect with an API key​

Find each value first:

  • Tenant URL: The address you open Qlik Cloud at, such as https://yourtenant.eu.qlikcloud.com, with no path after it.
  • API key: Qlik Cloud > your profile picture > Profile settings > API keys > Generate new key; copy it when it is shown.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Qlik Cloud card.
  2. Name the secret and choose who can use it.
  3. Fill in Tenant URL, API key.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to Qlik Cloud with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls Qlik Cloud's API once (GET <Tenant URL>/api/v1/spaces?limit=1) with the stored values, and shows whether Qlik Cloud accepted it, or which value Qlik Cloud refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: base_url, api_key.

Tell the agent in your task description which secret to use, for example “use the Qlik Cloud secret org/qlik-cloud”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Qlik Cloud once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Qlik Cloud's side too, revoke or delete the key at Qlik Cloud.

Limitations​

  • An API key acts as the user who generated it, with that user's roles and space access.
  • API keys expire after the lifetime the Tenant Admin set; replace the key in Jaah before it lapses.
  • Qlik Sense Enterprise on Windows (client-managed) is not Qlik Cloud and is not supported by this connection.
  • Agents can do only what the connected Qlik Cloud account allows.

Troubleshooting​

Test says Qlik Cloud rejected the API key (401)

The key is wrong, expired or was revoked. Generate a new one in Profile settings > API keys, select Replace on the secret, and paste it.

The API keys section is missing from Profile settings

API keys are turned off for the tenant or your role lacks them. A Tenant Admin turns them on in Administration > Settings > API keys and gives you the Developer role.

Test says Qlik Cloud returned HTTP 404

The Tenant URL is not your tenant's root. Use the address in your browser, such as https://yourtenant.us.qlikcloud.com, with no path.

Still stuck? Select Test and read the result: it names the value Qlik Cloud refused and the status it answered.

FAQ​

Can I use an OAuth client instead of an API key?

Not yet. Jaah connects Qlik Cloud with an API key; a key generated by a dedicated service user keeps agents' access separate from yours.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Qlik Cloud account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.