Kyndryl Bridge

Experience Kyndryl Bridge

API keys for Bridge services and applications
Published On Jun 14, 2024 - 10:57 AM

API keys for Bridge services and applications

API keys allow to view, create, edit, regenerate, delete, or lock an API key.
An application programming interface (API) key is a unique encrypted identifier that is 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 Services account is first created, can manage the API keys. Likewise, other users can also manage APIs if the access policies they are part of have the correspondent permissions. To understand which roles and permissions are required, see Roles and permissions.

Accessing the API Keys Page for Services and Applications

  1. From the Kyndryl Bridge Console Home page access the secondary menu.
  2. From the App Manager dropdown, select IAM. The IAM page opens.
  3. Select API Keys from the left navigation bar of the page. The API Keys page opens.
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 the available keys that you have added to your account. Filter your API keys by using the filtering menu on the top of the page:
  • All User API keys
  • All Service ID API keys
  • My API keys
You can use the filter and search capabilities to do more specific searches.

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 Add.
  4. Copy the API key by clicking the Copy icon and close the message window.
The new API key is created and displayed under the API Keys page.
When you add a new API key, it is automatically assigned to your login user ID. This is displayed as a tag with the text Self next to your API key. API keys have the same access that the user ID has assigned across the Platform.

Editing an existing API key details

  1. Click the overflow menu next to the API key that you want to edit.
  2. Select View details.
  3. Click Edit 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 whether the API key has been locked before.
Whenever an API key is locked, you are not able to see the regenerate or delete options from the overflow menu. If a Service ID is locked, all API keys that belong to that Service ID are also locked. In that approach, API keys are dependent upon the parent Service ID.
Do you have two minutes for a quick survey?
Take Survey