Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Identity__delete Api Key

Permanently deletes a public API key for the current tenant. Requires a signed-in staff user. Needs the `identity__Tenant` `update` permission. Send the `x-tenant` header (the gateway sets it from your API key).

MUTATIONidentity__deleteApiKey(id: String!): Boolean!

Permanently deletes a public API key for the current tenant. Requires a signed-in staff user. Needs the identity__Tenant update permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

id*String!

Returns

identity__deleteApiKey*Boolean!
Example Request
mutation Identity__deleteApiKey($id: String!) {  identity__deleteApiKey(id: $id)}
Variables
{  "id": "string"}
Example Response
{  "data": {    "identity__deleteApiKey": true  }}