Skip to main content

createApiKey

Creates an API key: a machine-to-machine client in the tenant realm that authenticates with the OAuth2 client credentials grant. The returned clientSecret is shown exactly once and cannot be read again — a lost secret is replaced with rotateApiKeySecret. Only the tenant administrator can trigger this action.

Requires authorization features: api_key:core:create

createApiKey(
input: CreateApiKeyInput!
): CreateApiKeyPayload!

Directives​

auth​

Requires authorization features: api_key:core:create

Arguments​

createApiKey.input ● CreateApiKeyInput! non-null input​

Type​

CreateApiKeyPayload object​

Payload returned by the createApiKey mutation.