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.
MUTATION
identity__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
- identity__purgeTenant
jobId*String!queued*Boolean!tenantUid*String!Example Request
mutation Identity__purgeTenant($uid: String!) { identity__purgeTenant(uid: $uid) { jobId queued tenantUid }}{ "uid": "string"}{ "data": { "identity__purgeTenant": { "jobId": "string", "queued": true, "tenantUid": "string" } }}