c.l.cladDocs

API keys

Every API key and machine-user query and mutation.

Manage programmatic access itself: API keys and the machine users (API principals) they belong to.

Queries

apiKeys

apiKeys(machineUserId: ID): [ApiKey!]

API key metadata (never secrets), optionally filtered to one machine user.

ArgumentTypeDescription
machineUserIdID

machineUsers

machineUsers: [MachineUser!]

Service accounts in this organization.

Mutations

createApiKey

createApiKey(input: CreateApiKeyInput!): CreateApiKeyResult

Mint an API key for a service account. Human org admins only; the secret is returned exactly once.

ArgumentTypeDescription
inputCreateApiKeyInput!Required.

createMachineUser

createMachineUser(input: CreateMachineUserInput!): MachineUserResult

Create a service account. Human org admins only.

ArgumentTypeDescription
inputCreateMachineUserInput!Required.

revokeApiKey

revokeApiKey(id: ID!): ApiKeyResult

Revoke an API key immediately. Requires apikeys:revoke (admin-gated).

ArgumentTypeDescription
idID!Required.

setMachineUserActive

setMachineUserActive(id: ID!, isActive: Boolean!): MachineUserResult

Enable/disable a service account (disabling blocks all of its keys). Human org admins only.

ArgumentTypeDescription
idID!Required.
isActiveBoolean!Required.