Managing platform REST API keys

Create API keys associated with your user account, and then use them to authenticate when you call the platform REST APIs provided by API Connect.

About this task

The API Connect platform REST APIs require authentication for use. To call an API interactively, you can log into the toolkit CLI with an option to generate the API key. To call an API programmatically, you can generate an API key and then exchange it for an API Connect access token. This requirement applies only to the APIs that are provided by API Connect. You do not need the API key for calling APIs that you imported or created. The API key is intended for use with the OIDC user registry type.
Remember: By default, API keys are configured to be used only
once. However, you can customize the configuration and modify the API lifespan by following the
steps provided in the Configuring API key settings
topic.

Procedure

  1. Create an API key:
    1. Log in to API Connect Enterprise as a Service.
    2. Click your username in the banner to display your profile.
    3. On your profile page, click My API Keys.
    4. On the API Keys page, click Add.
    5. In the "Create API Connect API Key" box, provide a title for the key (unique within your user account) and a description.
    6. To specify a timeout value, select or type an integer value in the API key timeout field and then choose a unit of time (Seconds, Minutes, or Hours) in the Unit field.
      Note: The default timeout value is 5 minutes.
    7. Select Enable multiple use to allow applications to exchange the API key for an access token multiple times.
    8. Click Create.
      Note: The Create button is disabled until you provide a description.
  2. Manage API Keys:
    1. Log in to API Connect Enterprise as a Service.
    2. Click your username in the banner to display your profile.
    3. On your profile page, click My API Keys.
      The list of API Keys associated with your user account displays.
      • To view a key, click View the API Key on the same row as the key's title.
      • To copy a key, view it and then select Copy the API key in the "API key" box.
      • To delete a key, click Delete the API Key on the same row as the key's title, and click Delete when prompted to confirm the action.