- Docs
- API reference
- Endpoints and schemas
- Overview
Authentication and API keys
Send a key with each request, choose a personal or a service key, and rotate a key without downtime.
Send your API key in the x-api-key header. The GraphQL API and the KYB API
both read it from this header only. They do not accept it as a bearer token.
Manage keys on the API keys page of Settings in Enigma Console. The page opens after you choose a plan.
Workspaces
Section titled “Workspaces”A key belongs to one workspace. Its requests use that workspace’s plan and credits, and each key has its own rate limit.
Personal and service keys
Section titled “Personal and service keys”| Personal key | Service key | |
|---|---|---|
| Belongs to | One user | The workspace |
| Who can create it | Any member, for themselves | Admins |
| Who can see it | Its owner and admins | All members |
| When its creator leaves the workspace | Deleted | Kept |
Each member has a default personal key, which Enigma creates. Use a service key for production systems, so that they keep working when a person leaves.
Rotate a key
Section titled “Rotate a key”Keys do not expire. To rotate a key:
- Create a new key.
- Move your systems to the new key. Both keys work until you delete the old one.
- Delete the old key. A deleted key stops working at once, and you cannot restore it.
You cannot delete a default key. To rotate one, set the new key as the default first.
Disabled keys
Section titled “Disabled keys”Enigma disables a user’s keys until the user confirms their email address, or until an admin approves their request to join the organization. A disabled key gets a 403 response. You cannot disable a key yourself. To stop a key, delete it.