Prerequisites
The External API Access feature flag must be turned on for the tenant in question.
API Key Generation
Where Keys are Generated
API keys are generated in your platform profile section. To access this area, click your name in the top navigation bar (e.g., Welcome, [Your Name]) and navigate to the API Key Management or Profile Settings area. From there, you can generate new keys, view your existing API User ID, and manage credentials securely.
Note: Access to API key generation requires an Administrator role.
Key Generation
When you generate an API key, you’ll be shown the API User ID and the API Key. This key is displayed only once for security reasons — be sure to copy and store the API Key in a secure location. Once the window is closed, the key cannot be retrieved or restored.
⚠️ Note: This API Key may be used to authorize additional key generation. Handle it securely and restrict access accordingly.
If you lose access to your key, you will need to generate a new one through the API Key Management process.
Deleting Keys
If needed, administrators can manage and revoke access by deleting API keys from the User Profile screen. You have two options for removing keys:
Delete All
Click the Delete All button to remove all API keys associated with your account. This is useful when performing a full credential reset or if you suspect that a key has been compromised. Note that this action cannot be undone, and new keys will need to be generated to restore access.
Delete Individually
Each API key entry has a trash icon that allows you to delete keys individually. This provides more granular control when managing multiple keys—allowing you to remove only those that are expired, unused, or no longer authorized.
