Generating API keys for authentication

You can generate API keys at the service instance level to allow applications to authenticate without requiring user credentials.

Before you begin

You must have the Service owner or administrator role in the tenant account.

API keys provide programmatic access to service instance resources and are applicable at the instance level only.

To manage API keys, use the following guidelines:

Store API keys securely and do not commit API keys to source control or share them in plain text.
Rotate keys regularly by generating new keys periodically and deleting old or unused keys.
Grant only the minimum permissions required for each API key.
Review API key usage logs regularly.
Use separate API keys for different applications to limit exposure .

Click the service instance name in the workspace to access the service instance details.
From the Access management tab, select the API keys tab.
Click Generate API key and enter a descriptive name for the API key, assign permissions, and set an expiration date, if applicable.
Click Generate.

Important: For security reasons, the API key is only available to be copied or downloaded at the time of creation. Save the API key for your records.

Your application can now access the specific service instance with the generated instance API key.