Appearance
identity.end-user.purge ​
Hard-purge a previously soft-deleted end-user
Hard-purge a previously soft-deleted end-user for cleanup/erasure.
Inputs:
- actor: Cognito sub or user UUID
- organization_uuid: owning organization (required)
- identity_app_uuid: the app's identity tenant (required)
- end_user_uuid: the already soft-deleted end-user to purge (required)
- dry_run: count what would be deleted without deleting (optional)
Outputs (terminal state_data):
- end_user_uuid, identity_app_uuid, purged, not_found, dry_run, auth_codes_purged, verification_tokens_purged, app_grants_purged, purged_at
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
end_user_uuid | uuid | Yes | — | — |
dry_run | boolean | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
end_user_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
purged | boolean | Yes | — | — |
not_found | boolean | Yes | — | — |
dry_run | boolean | Yes | — | — |
auth_codes_purged | integer | Yes | — | — |
verification_tokens_purged | integer | Yes | — | — |
app_grants_purged | integer | Yes | — | — |
purged_at | string | Yes | — | — |
actor | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
reason | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | validate | — |
persisting | No | No | — | complete | — |
validating | No | No | — | persist | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | validate | validating | — |
validating | persist | persisting | — |
persisting | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.end-user.purge",
"initial_data": {
"actor": "value",
"organization_uuid": "value",
"identity_app_uuid": "value",
"end_user_uuid": "value"
}
}