identity.end-user.actor-binding.suspend ​
Suspend a Staff actor's ineligible end-user bindings (internal lifecycle hook)
Suspend every active end-user binding of a Staff actor that is no longer eligible (internal only).
Inputs:
- organization_uuid: the actor's organization (required)
- staff_actor_uuid: the actor (required)
- reason: token_revoked | seat_released | actor_archived | identity_disabled | app_unavailable (required). A pause is not a reason: a paused actor keeps its binding (F8)
- source_workflow_ref: caller run reference (optional, informational)
Trusted metadata: _identity_actor_binding_authorized_by in staff.revoke-actor-token, staff.archive-actor, staff.set-actor-rbac-mode, subscription.actor-rbac-seat.resize, identity.end-user.actor-binding.reconcile.
Outputs (terminal state_data):
- staff_actor_uuid, suspend_reason, authorized_by, suspended_count, still_eligible_count, bindings [{end_user_uuid, identity_app_uuid, suspended, code}]
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
staff_actor_uuid | string | Yes | — | — |
reason | string | Yes | — | — |
source_workflow_ref | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
staff_actor_uuid | string | No | — | — |
suspend_reason | string | No | — | — |
authorized_by | string | No | — | — |
suspended_count | integer | No | — | — |
still_eligible_count | integer | No | — | — |
bindings | list | 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 |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.end-user.actor-binding.suspend",
"initial_data": {
"organization_uuid": "value",
"staff_actor_uuid": "value",
"reason": "value"
}
}