Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Identity__revoke Api Key

Revokes 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__revokeApiKey(id: String!): ApiKey!

Revokes 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

  1. identity__revokeApiKey
createdAt*String!
id*String!
keyPrefix*String!
lastUsedAt?String
name*String!
revokedAt?String
scopes*[String!]!
status*ApiKeyStatus!
Value inactiverevoked
tenantUid*String!
Example Request
mutation Identity__revokeApiKey($id: String!) {  identity__revokeApiKey(id: $id) {    createdAt    id    keyPrefix    lastUsedAt    name    revokedAt    scopes    status  }}
Variables
{  "id": "string"}
Example Response
{  "data": {    "identity__revokeApiKey": {      "createdAt": "string",      "id": "string",      "keyPrefix": "string",      "lastUsedAt": "string",      "name": "string",      "revokedAt": "string",      "scopes": [        "string"      ],      "status": "active"    }  }}

Identity__reset Password MUTATION

Public: no sign-in needed.

Identity__send My Phone Verification Otp MUTATION

Requires a signed-in staff user.