Generate API Key
API keys can be used for supported integrations and components such as Code Guardian and MCP Gateway, based on the permissions assigned to the key.
Generate a Key
- Your role must include API key management permissions.
- You must select scopes during key generation. Know which system will use the key and what access it needs .
- Set the shortest expiry that meets your operational requirement. The default is 365 days; the maximum is 3650 days.
- Go to Settings > API Keys
-
Click Generate API Keyto open the Create API Key dialog.
The dialog provides the following fields:
- Enter a descriptive Name for the API key.Tip: Use the name of the system that will use the key. This helps you identify and revoke the right key quickly.
- Set Expires In (Days) to define how long the key remains
valid.
Enter the number of days until the key expires. The default is 365.
- Under Permissions, select the scopes required for the intended
integration or service.Tip: Grant only the permissions required for the intended use of the key.
- Enter a descriptive Name for the API key.
- Click Generate Key.
-
Copy the API Key After the key is generated, copy and store it
securely.
Important: The complete API key is displayed only once. Copy the key before leaving the page. Afterward, Agent Identity Security displays only the key prefix and does not expose the full key again. Select Done after you have securely stored the key.
