Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringNo——
organization_uuiduuidYes——
identity_app_uuiduuidYes——
staff_actor_uuidstringYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
foundbooleanNo——
identity_app_uuiduuidNo——
staff_actor_uuidstringNo——
end_user_uuiduuidNo——
statusstringNo——
status_reasonstringNo——
seatedbooleanNo——
group_slugstringNo——
app_organization_uuiduuidNo——
actor_bound_atstringNo——
actor_bound_by_user_uuidstringNo——
eligibilitydictNo——
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.get",
  "initial_data": {
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "staff_actor_uuid": "value"
  }
}