Skip to content
Proud to collaborate with Microsoft for Startups

data.identity.end-user.purge ​

Hard-delete one soft-deleted end-user and app-scoped cleanup rows

Hard-delete one already soft-deleted EndUser and app-scoped residues.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
identity_app_uuiduuidYes——
end_user_uuiduuidYes——
dry_runbooleanNo——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
end_user_uuiduuidYes——
identity_app_uuiduuidYes——
purgedbooleanYes——
not_foundbooleanYes——
dry_runbooleanYes——
auth_codes_purgedintegerYes——
verification_tokens_purgedintegerYes——
app_grants_purgedintegerYes——
purged_atstringYes——
actorstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
reasonstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completePurge soft-deleted end-user
completedNoYesYes—Purge complete
failedNoYesNo—Purge failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.identity.end-user.purge",
  "initial_data": {
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "end_user_uuid": "value"
  }
}