Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Identity__purge Tenant

System-admin only. Enqueues a background job that deletes the tenant and all tenant-scoped data. Platform admin only.

MUTATIONidentity__purgeTenant(uid: String!): PurgeTenantPayload!

System-admin only. Enqueues a background job that deletes the tenant and all tenant-scoped data. Platform admin only.

Arguments

uid*String!

Returns

  1. identity__purgeTenant
jobId*String!
queued*Boolean!
tenantUid*String!
Example Request
mutation Identity__purgeTenant($uid: String!) {  identity__purgeTenant(uid: $uid) {    jobId    queued    tenantUid  }}
Variables
{  "uid": "string"}
Example Response
{  "data": {    "identity__purgeTenant": {      "jobId": "string",      "queued": true,      "tenantUid": "string"    }  }}