Appearance
identity.app.deprovision ​
Deprovision an identity app and invalidate app-owned identity state
Deprovision an identity app and invalidate app-owned identity state.
Inputs:
- organization_uuid, identity_app_uuid (required)
- actor, reason (optional)
Outputs:
- deprovisioned, already_deprovisioned, status, deleted_at
- counts for clients/providers/end-users/grants/codes/tokens touched
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | No | — | — |
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
reason | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
identity_app_uuid | uuid | Yes | — | — |
deprovisioned | boolean | Yes | — | — |
already_deprovisioned | boolean | Yes | — | — |
status | string | No | — | — |
deleted_at | string | No | — | — |
clients_deprovisioned | integer | No | — | — |
federation_providers_deprovisioned | integer | No | — | — |
end_users_deprovisioned | integer | No | — | — |
app_grants_deprovisioned | integer | No | — | — |
auth_codes_revoked | integer | No | — | — |
verification_tokens_revoked | integer | No | — | — |
exposed_virtual_workflows_removed | integer | No | — | — |
persisted | boolean | No | — | — |
actor | string | No | — | — |
reason | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | validate | — |
deprovisioning | No | No | — | complete | — |
validating | No | No | — | deprovision | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | validate | validating | — |
validating | deprovision | deprovisioning | — |
deprovisioning | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.app.deprovision",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value"
}
}