Appearance
data.identity.user.prune ​
Hard-delete expired soft-deleted Users and their API tokens / notification prefs
Hard-delete soft-deleted User rows past the retention window.
Input: retention_days (default 90), optional dry_run, organization_uuid, actorll optional). Output in state_data: users_pruned, tokens_pruned, prefs_pruned, dry_run, pruned_at.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
retention_days | integer | No | — | — |
organization_uuid | uuid | No | — | — |
dry_run | boolean | No | — | — |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
users_pruned | integer | Yes | — | — |
tokens_pruned | integer | Yes | — | — |
prefs_pruned | integer | Yes | — | — |
dry_run | boolean | Yes | — | — |
pruned_at | string | Yes | — | — |
retention_days | integer | No | — | — |
organization_uuid | uuid | No | — | — |
actor | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Prune expired users |
completed | No | Yes | Yes | — | Prune complete |
failed | No | Yes | No | — | Prune failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.identity.user.prune",
"initial_data": {
"retention_days": 123,
"organization_uuid": "value",
"dry_run": true,
"actor": "value"
}
}