Search documentation

Search for a topic, a control, or an event type.

    Docs / Administration / API keys

    API keys

    Authenticate scripts and external services as a person or service account. Each key uses its owner’s current OAIZ permissions.

    The key’s owner

    A personal key uses your account’s permissions. A service-account key uses that account’s resource grants and team memberships. Managing a service account does not give it your own resource access.

    Keys do not have a separate resource permission list. Change the owner account’s grants to change what its keys can reach. Organization two-factor requirements apply to sign-in sessions rather than API-key requests.

    Create a key

    In Settings, under API, open API keys and choose Create API key. Give the key a name and choose an expiration date or No expiration date. Choose No service account (personal key) for your own key, or choose an ordinary service account you manage. For a custom integration account, create keys in its Incoming API keys section. A service account can be managed by a person or by a team. Current Managers of that team manage the account and its keys. Organization Administrators can also create keys for service accounts in their organization.

    The complete value is available only when the key is created. Copy it into the calling service’s secret configuration. The saved key list shows its name, owner and expiry, without revealing its value.

    Revoke a key

    Select keys in API Keys and use Delete Keys. You can revoke your own keys and keys for service accounts you manage. Changing the manager keeps existing keys working. The new managers can revoke them. Organization Administrators can revoke service-account keys across the organization.

    Revocation stops that key and ends sessions created from it. Other keys and signed-in sessions remain. An already-started job can continue under its execution credential until it completes or times out.

    Accounts managed by OAIZ

    Job accounts are tied to their jobs and cannot have API keys. OAIZ supplies their execution credentials when a job runs.

    Custom integrations can have a connection-managed service account. Its API keys are managed in the custom integration’s Incoming API keys section by the account’s manager or an organization Administrator. A person temporarily acting as a service account cannot create keys for it.

    Use a key

    Send the key in the Authorization header as a Bearer credential. The API reference explains request URLs and supported operations.

    Authorization header
    Authorization: Bearer YOUR_API_KEY