Setting up the API Key

On how to provide the relevant rights to the Catalog Qlik user

Requirements

• Ability to use (or create) a user with access to needed spaces

• Ability to create an API for that user

• This user must have at least the "Developer" role

1. Get a Qlik API key

Option A: create a Catalog Qlik user

You can invite [email protected] to your Qlik instance. The Catalog team will then create the API key using the Qlik UI

• Invite a new user using: [email protected]

• Allocate a license to this user with a Professionnal license

Option B: add a key to an existing user

If you have an account with sufficient priviledges, you can simply create an API key linked to your account.

• Go on your profile settings, click on API Keys

• Create an API key

• Input the API key in the App with the following format:

{
    "apiKey": "*****",
    "baseUrl": "https://xxxx.xx.qlikcloud.com"
}

2. Add this user to the wanted spaces

• Add the user chosen above to each space you want to see in Catalog. The "Can Manage" right is required

• For lineage purposes, make sure to also add Apps that are used for data transformation. Keep in mind that Catalog cannot compute lineage on what Catalog cannot see.

• Space access grant access to all space apps, except when using Section Access. For these apps, you'll need to add the Catalog user one by one (or using a script)