Skip to main content

CreateApiKeyInput

No description

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

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).

Member Of

createApiKey mutation