Skip to main content

ApiKeyMutations

No description

type ApiKeyMutations {
  createApiKey(
    name: String!
    permissions: PermissionsInput!
    expiresAt: ZonedDateTime
  ): CreatedApiKey
  updateApiKeyPermissions(
    orgApiKeyId: Long!
    permissions: PermissionsInput!
  ): OrgApiKey
  rotateApiKey(
    orgApiKeyId: Long!
  ): String
  revokeApiKey(
    orgApiKeyId: Long!
  ): Boolean
}

Fields​

ApiKeyMutations.createApiKey ● CreatedApiKey object​

Create an organization API key for the GraphQL API (name + explicit permission set + optional expiry). Returns the plaintext key exactly once. Requires Owner or Admin role; API-key-authenticated requests can never manage keys.

ApiKeyMutations.createApiKey.name ● String! non-null scalar​
ApiKeyMutations.createApiKey.permissions ● PermissionsInput! non-null input​
ApiKeyMutations.createApiKey.expiresAt ● ZonedDateTime scalar​

ApiKeyMutations.updateApiKeyPermissions ● OrgApiKey object​

Replace an API key's permission set. Requires Owner or Admin role.

ApiKeyMutations.updateApiKeyPermissions.orgApiKeyId ● Long! non-null scalar​
ApiKeyMutations.updateApiKeyPermissions.permissions ● PermissionsInput! non-null input​

ApiKeyMutations.rotateApiKey ● String scalar​

Rotate (cycle) an API key: new key material on the same key (name, permissions and expiry are kept); the old key stops working immediately. Returns the new plaintext key exactly once. Requires Owner or Admin role.

ApiKeyMutations.rotateApiKey.orgApiKeyId ● Long! non-null scalar​

ApiKeyMutations.revokeApiKey ● Boolean scalar​

Revoke (delete) an API key; it stops working immediately. Requires Owner or Admin role.

ApiKeyMutations.revokeApiKey.orgApiKeyId ● Long! non-null scalar​

Returned By​

apiKeys mutation