Skip to main content

disableApiKey

Disables an API key. The key keeps its permissions and its secret, but no longer receives a token until it is enabled again. Only the tenant administrator can trigger this action.

Requires authorization features: api_key:core:manage

disableApiKey(
  input: DisableApiKeyInput!
): DisableApiKeyPayload!

Directives​

auth​

Requires authorization features: api_key:core:manage

Arguments​

disableApiKey.input ● DisableApiKeyInput! non-null input​

Type​

DisableApiKeyPayload object​

Payload returned by the disableApiKey mutation.