Training Create an API Key

Training: Create an API Key

What you'll learn: how to create a user API key for an integration, and how to manage keys safely. You need: Administrator access type, enterprise admin application. Time: 4 minutes.

Steps

1. Go to Left menu → Access Control → API Keys. (Fallback: search "API Keys" in the header.)
2. Click + in the toolbar (or use GET API KEY on Enterprise Admin Home). The Create new API Key dialog opens.
3. Type a Name you'll recognize later (e.g. the integration's name).
4. Pick the Tenant (application) the key is scoped to.
5. Pick the User the key will act as.
6. Click ✓.
7. Copy and store the key now — the secret is shown only at creation and can never be viewed again.

Check your work

The key is listed with Active ✓. Its Last Authenticated At fills in the first time the integration uses it.

Good habits

• Keys inherit the chosen user's access in the chosen application — treat them as credentials.
• Lost key? Delete it and create a new one (use the Name to track generations).
• Keys with an empty Last Authenticated At have never been used — review and clean up.
• Deactivating a user deactivates their keys automatically.

Related training

Training: Create an Enterprise User · Training: Investigate Login Activity