Using IBM Cognos Analytics APIkey Authentication

Using IBM Cognos Analytics APIkey Authentication

Overview

As of the Digital Hive 2024.2 release, it is possible to leverage API keys generated in IBM Cognos Analytics, to secure and access Cognos content. This method of authentication should be considered when traditional Single Sign On options aren't possible. Each user will have to have to create their own API key for user within Digital Hive.

Before any configuration changes can be made in Digital Hive, the API key for the Digital Hive system credential user, must be created.
  1. Log into IBM Cognos Analytics as the Digital Hive system credential user
  2. Click on the user's avatar in the upper right-hand corner to open the Personal Menu
  3. Click on Profile and Settings

  4. Look for the My API keys entry and press Manage

  5. Press the  icon
  6. In the Generate API key window, provide a Name and optional description

  7. Press Next
  8. The API key successfully generated window will appear. Press Copy to clipboard

  9. Press Done

To configure an existing IBM Cognos Analytics connector within Digital Hive:
  1. As an administrator log into Digital Hive
  2. Click on the user's avatar and select Manage Digital Hive
  3. From within the Control Center select Connectors
  4. Click on the IBM Cognos Analytics connector definition to open the details
  5. Open the  tab
  6. Change the value of the Authentication Method dropdown to Cognos API key
  7. Press Save
Reminder: Users will have to update their personal credentials, accessible from their avatars, so that they can connect to Cognos using their API keys.

For complete documentation around configuring an IBM Cognos Analytics connector: https://support.digitalhive.com/portal/en/kb/articles/connecting-to-ibm-cognos-analytics