API Keys

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 you can also associate api keys with service ids, access groups and users for details, see – service ids docid\ r ctigt9hnbzejsm7lzrv for details, see access groups docid\ hzc4qy5gh7gwklhfysayc for details, see – users docid 7caos2ibikfbh9x bz51x api keys page the api keys page provides a centralized location for creating, viewing, and managing api keys within your account from this page, authorized users can monitor existing api keys, manage access credentials, and control application access to 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 main menu , go to administration → → 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 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 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 apis follow these steps to create a new api key on the api keys page, click create api key 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 click create api key copy the generated key using the copy icon 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 select the overflow menu next to the api key you want to modify select edit key and update the name and description 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 select the overflow menu next to the api key you want to regenerate select regenerate copy the new api key using the copy icon 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 click the overflow menu next to the api key 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 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 select the overflow menu next to the api key that you want to edit select the lock or unlock option, depending on whether the api key has been locked before confirm the action 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 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