Enable the API Key Management feature by navigating to Administration>System Settings>Features tab
Note: once enabled, there is no reverting back to the legacy system
Toggle the option to ON.
Key generation behavior:
- You must copy the key upon creation. You can access the key after creation. This is a security feature.
- Keys can be rotated or revoked. Key rotation means a new key will be generated on the existing resources it’s been granted to. Key revoke means that key will no longer function.
Permissions:
- System admins can create and manage keys and assign keys to Jobs and Bots
Grant API Key access to a specific job
- Toggle Enable API to turn ON
- Select Grant Key Access
- Search for the key by name and select the checkbox of the key you'd like to use, then select Grant Access in the bottom right
- You can Revoke access to a key by selecting the Revoke Access button in the Actions section
- Search for the key by name and select the checkbox of the key you'd like to use, then select Grant Access in the bottom right
NOTES:
- You must enable API Access to use API Factory or MCP Factory
- Seamless transition for existing API factory jobs and bots once Key Management is enabled