Kyndryl Bridge

Experience Kyndryl Bridge

API keys
Published On Jul 18, 2024 - 12:58 PM

API keys

An application programming interface (API) key is a unique encrypted identifier used to identify an application or user.
API keys are normally used to track and control connections and performance of how the system interface is being used; thus, it provides authentication in the calling of a program to another API to confirm a project is authorized for connection. The benefit of API keys is that it may prevent abuse or misuse of the APIs. API keys are an initial step in cloud API security by providing the connecting API with a password-like code with a defined set of access rights.
Users with an Administrator role, which is the out-of-the-box role granted when the Kyndryl Bridge Applications account is first created, can manage the API keys. Likewise, other users can also manage API keys if the access policies they are part of have the correspondent permissions.

Accessing the API Keys page

  1. Click the
    Account Switcher
     option located at the top right of the page.
  2. Select
    Access Management
    .
  3. Select the
    API Keys
     tab.
Once in the API Keys page, you can perform a series of actions to personalize your API keys needs, including the following:
  • Viewing a list of API keys
  • Creating a new API key
  • Editing an existing API key details
  • Regenerating API key
  • Deleting an existing API key
  • Locking and unlocking API keys

Viewing a list of API keys

By accessing the API Keys page, you are presented with a card that displays the total number of API keys available, and a list of such keys that you have added to your account.

Creating a new API key

To create a new API key, follow these steps:
  1. Click
    Add New API Key
    .
  2. Enter the name of the API key and an optional description.
  3. Click
    Create New API Key
    .
  4. Copy the API key by clicking the copy icon or download Key and then you can return to
    API Keys
     page or close the message window.
The new API key is created and displayed under the
API Keys
 page.

Editing an existing API key details

  1. Click the overflow menu next to the API key that you want to edit.
  2. Click
    Edit Key
     to update the name and the description of the API key.

Regenerating API key

  1. Click the overflow menu next to the API key that you want to regenerate.
  2. Select
    Regenerate API key
    .
  3. Copy the API key by clicking the copy icon and close the message window.

Deleting an existing API key

  1. Click the overflow menu next to the API key that you want to delete.
  2. Select
    Delete
    .
  3. Confirm the deletion.

Locking and unlocking API keys

You can prevent an API key from being deleted or modified by locking it. A locked API key is represented by the
Locked
 icon. You can unlock an API key at any time to update or delete it from your platform.
To lock or unlock an API key, follow these steps:
  1. Click the overflow menu next to the API key that you want to edit.
  2. Select
    Lock
     or
    Unlock
     option whether the API key has been locked before.
Whenever an API key is locked, the regenerate, edit and delete actions will not be available.
Do you have two minutes for a quick survey?
Take Survey