This article describes how to manage and generate required API keys used to authenticate with the Tealium API.

In this article:

Table of Contents Placeholder

Prerequisites

  • To generate or interact with your own key, you must first be authorized by another user with the Manage Users permission.
  • To authorize keys for other users, you must have the Manage Users permission.

How It Works

Unique API keys are used to authenticate with the Tealium API and linked to individual user accounts.

API keys are generated as follows:

  • An administrator with the Manage Users permission authorizes an API key for one or more users.
  • The authorization action triggers an email to the affected users, which notifies them that they are authorized to generate an API key. Those users can then generate their own API key.

API keys can be authorized, revoked, and generated directly from the iQ Tag Management (TiQ) interface. Once an API key is generated and displayed to the user, it cannot be retrieved again. Lost or forgotten keys must be reset or revoked by a user with the Manage Users permission.

About the Manage Users Permission

Users with the Manage Users permission can do the following:

  • Authorize (or reset) API keys for other users within their primary account.
  • Revoke API keys for other users within their primary account.

Regardless of Manage Users permissions, users who have been authorized to generate an API key can do the following:

  • Generate (or reset) their own API key.
  • Revoke their own API key.

Managing API Keys

The following sections describe the permissions and steps required to authorize a user to generate their own API key, how users generate their own API key, and how to manage API keys (authorize, rest, or revoke) for one or more users.

Authorizing a User to Generate API Keys

To authorize a user to generate API keys, you must be an administrator with the Manage Users permission. In this step, you are not generating keys for a users, but authorizing the user to generate their own API key.

Use the following steps to authorize a user to generate their own API keys:

  1. Click your user icon in the upper right of the screen and select Manage Users.
  2. The User Manager dialog displays.
  3. Use the checkboxes to select one or more users to manage.
  4. Click Edit/View User Settings.
  5. In the left side panel, click API Key.
  6. Click Authorize Generation.
    WhiteUI_TiQ_Managing and Generating API Keys_Authorize Generation.jpg
    A message displays that the API key authorization email was sent.
  7. Click Close to close the window.

Generating the API Key

Users must receive prior authorization to generate their own API key. Once authorized, the user receives an email notification instructing them to generate their API key.

Once the email is received, users can generate their own API key using the following steps:

  1. Click your user icon in the upper right of the screen and select Edit/View User Settings.
  2. In the left side panel, click API Key.
  3. Click Generate Key.
    The API key is generated and displayed in a pop-up window.

    The API key is only shown once and cannot be viewed later. Once you close this window, the API key cannot be displayed again.

  4. Copy the API key to a secure location before proceeding.
  5. Click Close to close the window.

Managing API Keys for Single Users

Use the following steps to manage API keys for a single user:

  1. Click your user icon in the upper right of the screen and select Manage Users from the drop-down list.
    The User Manager dialog displays.
  2. Click the checkbox next to the user for which you want to manage the API key.
  3. Click Edit/View User Settings.
    WhiteUI_TiQ_Managing and Generating API Keys_User Manager_EditView User Settings.jpg
  4. In the left side panel, click API Key.
  5. Select one of the following actions:
    • Authorize Generation
      Authorizes the user to generate their own key.
    • Reset Key
      Reset s the existing key and authorize a new key to be generated.
    • Revoke Key
      Revokes the existing key.
  6. Click Close to close the dialog.

Managing API Keys for Bulk Users

API keys can be authorized, reset, or revoked in bulk.

Use the following steps to manage API keys in bulk:

  1. Click your user icon in the upper right of the screen and select Manage Users from the drop-down list.
    The User Manager dialog displays.
  2. Click the checkbox next to each user for which you want to manage the API key.
  3. Click the More drop-down list and select Manage API Keys.
    WhiteUI_TiQ_Managing and Generating API Keys_Admin Select Users.jpg
    The selected users display in the left panel.
  4. Select the desired action:
    • Authorize / Reset Keys
      • Authorizes new users to generate an API key and resets the API key for existing users.
      • Existing keys are immediately invalid and the user must then generate a new API key.
    • Revoke Keys
      • Revokes existing API keys for selected users.
      • Revoked keys immediately become inactive for the users selected.
  5. Click Save.
    A confirmation message displays and an email notification regarding the update is sent to the affected users.
  6. Click Close to close the window to return to the previous screen.