Skip to main content

API keys

API keys let you perform actions in your Mitzu organization through the Mitzu API. Each key is tied to your organization, not an individual workspace: it can read and change the table configuration of every workspace and manage members and workspace access like an Org Admin, so store it as a secret.

Only admins can see and manage API keys. API access is not enabled by default; if the API keys tab shows that the API is not enabled, contact support@mitzu.io to turn it on for your organization.

What an API key can do​

Every API key can manage the organization's members like an Org Admin: invite, update and remove people, change licenses, org roles and workspace roles, decide join requests, and open or restrict workspaces. It can change and remove other Org Admins too. It can never change the Org Owner's license or org role, remove the Org Owner, or change who owns a workspace or the organization. See Managing access with the API for the details.

A key belongs to the organization, not to the admin who created it. It keeps working when that person is made an Org Member or leaves the organization. When an admin leaves or loses their admin role, disable or remove the keys they had access to, and create new ones if you still need them.

Viewing existing API keys​

Your existing API keys are shown in a table with the following columns:

  • Name — a label used to identify the API key.
  • Expires at — the date the key stops working.
  • State — the current status: enabled, disabled, or expired.
image

Creating a new API key​

  1. Click Add new API key.
  2. In the dialog, enter a Name and (optionally) an Expiration Date. Leave the expiration date empty if you want the key to never expire.
  3. Click Add to generate the key.
image

The generated key is displayed once. Copy it immediately — Mitzu will not show it again after the dialog is closed.

image

Enabling or disabling an API key​

You can toggle a key between enabled and disabled without deleting it:

  1. Select the key by checking the box in its row.
  2. Click Enable / Disable.
  3. The key's state updates immediately.

Deleting an API key​

  1. Select the key by checking the box in its row.
  2. Click Remove.
  3. In the confirmation dialog, click Delete to permanently remove the key.
image