Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
staff_actor_uuidstringYes——
reasonstringYes——
source_workflow_refstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
staff_actor_uuidstringNo——
suspend_reasonstringNo——
authorized_bystringNo——
suspended_countintegerNo——
still_eligible_countintegerNo——
bindingslistNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
reasonstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

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"
  }
}