Skip to main content

CreateApiKeyInput

No description

input CreateApiKeyInput {
id: String
accountId: String
name: String
roleId: String!
isAgent: Boolean
expiry: ApiKeyExpiry
}

Fields​

CreateApiKeyInput.id ● String scalar​

Optional client-supplied id; ignored — the key id is generated server-side.

CreateApiKeyInput.accountId ● String scalar​

The account the key is minted for; must hold an active seat in the caller's workspace.

CreateApiKeyInput.name ● String scalar​

Human-readable label for the key.

CreateApiKeyInput.roleId ● String! non-null scalar​

The role the key's permissions are scoped to; must be a live role in the workspace.

CreateApiKeyInput.isAgent ● Boolean scalar​

When true, the key evaluates permissions in agent mode (agent grants only).

CreateApiKeyInput.expiry ● ApiKeyExpiry enum​

How long the key stays valid; 90 days when omitted. Fixed at creation; once it passes, the key is refused and a new one must be created. A key created by an API key that expires cannot outlive it: a longer lifetime is shortened to end when the calling key does, and NEVER is refused.

Member Of​

createApiKey mutation