revokeApiKey

Requires at least one of the permissions settings:api:delete or settings:tenant:update.

Revoke an API key permanently. Requires permission to delete API keys or update tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RevokeApiKey($id: String!) {
  revokeApiKey(id: $id)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RevokeApiKey($id: String!) {\n  revokeApiKey(id: $id)\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

{
  "data": {
    "revokeApiKey": true
  }
}

revokeApiKey(
  id: String!
): Boolean!

Arguments

revokeApiKey.id ● String! non-null scalar

The ID of the API key.

Type

Boolean scalar

The Boolean scalar type represents true or false.