identity.end-user.actor-binding.get ​
Read a Staff actor's end-user binding in an app and its eligibility
Read a Staff actor's end-user binding in an app, with its eligibility codes.
Callers: a human member of the organization, or the bound actor itself (an agent principal whose staff_actor_uuid matches). End users and other agents are refused.
Inputs:
- organization_uuid, identity_app_uuid, staff_actor_uuid (required)
Outputs (terminal state_data):
- found, identity_app_uuid, staff_actor_uuid, end_user_uuid, status, status_reason, seated, group_slug, app_organization_uuid, actor_bound_at, actor_bound_by_user_uuid, eligibility {ok, code, app_code} — codes only, no seat counts. An agent caller receives wire codes (ACTOR_APP_ORG_MISMATCH reads as ACTOR_END_USER_NOT_BOUND)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| 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 | — | — |
staff_actor_uuid | string | Yes | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
found | boolean | No | — | — |
identity_app_uuid | uuid | No | — | — |
staff_actor_uuid | string | No | — | — |
end_user_uuid | uuid | No | — | — |
status | string | No | — | — |
status_reason | string | No | — | — |
seated | boolean | No | — | — |
group_slug | string | No | — | — |
app_organization_uuid | uuid | No | — | — |
actor_bound_at | string | No | — | — |
actor_bound_by_user_uuid | string | No | — | — |
eligibility | dict | 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.get",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value",
"staff_actor_uuid": "value"
}
}