Creating API keys

Edit online

Use IBM® Guardium® Exposure Manager APIs (application programming interfaces) to interact with other applications, such as IBM Guardium Data Protection, universal connectors, and IBM Guardium Exposure Manager reports.

Before you begin

You can generate API keys in IBM Guardium Exposure Manager. You can then use the keys to authenticate to the interactive API or as basic keys for authentication in cURL commands.
Note: You can also create and use an OAuth authorization token, as described in Accessing APIs with OAuth.
From the IBM Guardium Exposure Manager API keys page, you can link to the API reference landing page, and then to the API reference, which lists the available APIs.

Procedure

  1. From the main menu, click Access management > API keys.
  2. On the API keys page, click Create API key to open the Create API key dialog.
  3. In the Step 1. Generate section of the Create API key dialog, enter the API key description to distinguish this key from other keys that you generate, and then click Create API key.
    The following information appears in the Step 2. Retrieve section of the Create API key dialog that you need to access and use the API.
    • API key: Use the API key as the Username when you access the IBM Guardium Exposure Manager API user interface.
    • Secret API key: Use the secret key as the Password when you access the IBM Guardium Exposure Manager API user interface.
    • Encoded token: Use the encoded token to create the token header that you use to call the IBM Guardium Exposure Manager API. For more information, see Calling APIs.
    Important:

    After you close the Create API key dialog, you cannot access the API key you just created. Therefore, click the Copy icon next to the API key, Secret API key, and Encoded token, and then paste that information to another location (such as a text file) to store this information securely.

    Additionally, you can use the API key, Secret API key, and Encoded token in either of the following ways:
    • Copy the Encoded token only and use it to authenticate, and then use the APIs.
    • Copy both the API key and the Secret API key to generate the token, and then use the APIs.
  4. Click Done to close the Create API key dialog and return to the API keys page.

Results

The API keys that you create appear in the table in the API keys page. You can view your key names without any encoded information. To remove the key, click the Delete icon in the row of the key that you want to delete.

After you create the keys and token, you can use them to call the APIs.