---
title: API Keys
slug: api-keys
docTags: 
createdAt: 2026-07-20T18:32:09.281Z
---

API keys are secure identifiers used to authenticate applications and services when they connect to APIs. They function as password-like tokens with a defined set of access rights, helping ensure that only authorized applications can access APIs. API keys also support monitoring and tracking of API usage, enabling administrators to identify misuse, control access and improve the security of integrations. As a foundational component of cloud API security, API keys help protect services while allowing controlled communication between systems.

# Prerequisites 

The following prerequisites must be met to manage API keys:

- **Administrators** can manage all API keys.
- **Non-administrator users** can manage their own API keys.
- **Non-administrator users** can manage other users' API keys when their assigned access policies grant the required permissions.

:::hint{type="info"}
You can also associate API keys with **Service IDs, Access Groups** and **Users.**

           For details, see Bridge Access Management – [Service IDs](docId\:I2WXFQP2tstQi7GfvOF18)

           For details, see Bridge Access Management -  [Access Groups](docId\:HZc4qy5Gh7gwkLHfYsAyC)

           For details, see  Bridge Access Management – [Users](docId:7caOs2IBiKFBH9x-bz51X)       
:::

# API Keys page

The **API Keys **page provides a centralized location for creating, viewing, and managing API keys within your Kyndryl Bridge account. From this page, authorized users can monitor existing API keys, manage access credentials, and control application access to Kyndryl Bridge services. The page also displays a summary card with the total number of API keys available, along with a list of the API keys associated with your account.

# Accessing the Users page

From the Kyndryl Bridge main menu :inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/NK7Yw9tQgnlqBGwu7eG4H-20260601-205917.svg" alt caption width="28" height="28"}, go to **Administration** → Bridge Access Management → **API Keys **

# Managing API Keys

The **API Keys **page enables authorized users to create and manage API keys used for secure authentication between applications and Kyndryl Bridge services. From this page, based on your role, you can create new API keys, view and update key details, regenerate credentials, lock or unlock keys and remove keys that are no longer needed. These capabilities help maintain secure access to APIs while providing control over how applications integrate with Kyndryl Bridge services.

## 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

Create a new API key to enable secure authentication for applications and services that access Kyndryl Bridge APIs. Follow these steps to create a new API key:

1. On the **API keys** page, click **Create API Key**. 
2. Enter the **name** (mandatory) and **description** (optional). 
   - Use unique names that start with a letter and can include letters, numbers, underscores, and hyphens (up to 60 characters). 
   - Write descriptions up to 100 characters long and may include special characters. 
3. Click **Create API key**. 
4. Copy the generated key using the **copy icon **:inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/TlS7H4A_o_JkOnMrBZlrD-20260602-174641.svg" alt caption width="28" height="28"} or select **Download Key**. The new API key appears in your list. 

## Editing an API key 

Update the name or description of an existing API key to keep key information accurate and easy to identify. Follow these steps to edit an API Key:

1. Click the **overflow** menu:inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/JndGM9EedPv0uB0o6JMpp-20260601-221027.svg" alt caption width="28" height="28"}next to the API key you want to modify. 
2. Select **Edit Key** and update the name and description. 
3. Click **Update**. 

## Regenerating API key

Regenerate an API key when you need to replace an existing key value while preserving the associated configuration and permissions. Follow these steps to regenerate an API Key:

1. Click the **overflow** menu:inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/JndGM9EedPv0uB0o6JMpp-20260601-221027.svg" alt caption width="28" height="28"}next to the API key you want to regenerate.
2. Select **Regenerate**.
3. Copy the new API key using the **copy icon **:inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/TlS7H4A_o_JkOnMrBZlrD-20260602-174641.svg" alt caption width="28" height="28"} or select **Download Key**. 

## Deleting an API key 

Delete an API key when it is no longer required or should no longer be used to access Bridge services.  Follow these steps to delete an API Key:

1. Click the **overflow menu** next to the API key. 
2. Select **Delete **and 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 :inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/ISzYWnQSznncH1WQKGEeq-20260602-175146.svg" alt caption width="28" height="28"}. 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 :inlineImage[]{src="https://api.archbee.com/api/optimize/QU1TIK52ntw5Jsos0uOt5/nSYuNUHJdb4gGBAWMXOSC-20260602-172708.svg" alt caption width="28" height="28"} next to the API key that you want to edit.
2. Select the **Lock** or **Unlock** option, depending on whether the API key has been locked before.
3. Confirm the action.

:::hint{type="info"}
Whenever an API key is locked, the regenerate, edit, and delete actions will not be available.
:::

# Best practices 

The following best practices can help you manage API keys securely and efficiently:

- Assign descriptive names so keys are easy to identify. 
- Lock keys that are in using to prevent accidental changes. 
- Periodically rotate API keys to maintain security. 
- Delete keys that are unused or outdated to reduce risk. 
- Use different keys for different integrations to track usage and limit the impact if one key is compromised. 
- Least privilege: keep role and policy scopes minimal and specific.
- Use access groups: assign policies to groups to scale consistently.
- Name clearly: use descriptive names for roles, policies, service IDs and API keys.
- Rotate credentials: regenerate API keys on a regular cadence and after personnel changes.
- Review regularly: audit roles, policies, service IDs and keys each release and retire what you no longer need.
- Lock when stable: lock service IDs and keys to avoid accidental changes.

# Troubleshooting

If you encounter issues while creating, managing, or using API keys, review the following troubleshooting guidance and recommended resolutions to help identify and resolve common problems.

**Symptom**: User cannot see expected resources.
**Likely cause**: Policy is attribute scoped and tags do not match.
**Fix**: Align user or service ID attributes with resource tags; recheck policy scope.

**Symptom**: “Assign policy” lists only “platform” in Service.
**Likely** **cause**: No Kyndryl Bridge service registered to Platform Central.
**Fix**: Register the service, then select it in the Service drop-down.

**Symptom**: API key actions are disabled.
**Likely** **cause**: Key is locked.
**Fix**: Unlock the key to edit, regenerate or delete.

**Symptom**: Service ID cannot be modified.
**Likely** **cause**: Service ID is locked.
**Fix**: Unlock the service ID; note it overrides individual API key lock states.

**Symptom**: Custom role seems incomplete.
**Likely** **cause**: Permissions not selected during creation.
**Fix**: Edit the role; add specific permissions from the populated list and save.