API keys
A secret credential that authenticates a user over RPC, MCP, and CLI with that user's permissions.
- API name:
apikeys - Domain: Auth
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| User | referenceId | User | Yes | |
| Name | name | Text | ||
| Permission role | roleId | Reference | The role whose lines the key acts with. Without a role the key holds nothing. | |
| Created at | createdAt | Timestamp | Yes | |
| Updated at | updatedAt | Timestamp | Yes |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
Actions
What you can do with a record. Every action also sends the webhook event apikeys.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Edit | update | Save changes to this api key. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this api key and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
Events
Moments the record reaches on its own. Subscribe to them with a webhook.
| Name | Webhook event | Description |
|---|---|---|
| Issued | apikeys.issued | An API key was issued. |
| Revoked | apikeys.revoked | An API key was revoked. |