Skip to content
Proud to collaborate with Microsoft for Startups

identity.end-user.actor-binding.list ​

List Staff-actor end-user bindings across the organization's identity apps

List the organization's Staff-actor end-user bindings across its identity apps (paged).

Callers: a human member of the organization, or a Staff actor reading its OWN bindings (an agent principal; staff_actor_uuid defaults to the caller and any other actor is refused). End users, integration keys, system principals and actor-less calls are refused.

Inputs:

  • organization_uuid (required)
  • staff_actor_uuid: only this actor's bindings (optional; every actor when omitted)
  • identity_app_uuid: only this app's bindings (optional; must belong to the organization)
  • status: active | suspended | disabled (optional). Unbound bindings (status disabled) are listed only when status=disabled is asked for
  • limit: page size (optional, default 100, max 500)
  • offset: page offset (optional, default 0)

Outputs (terminal state_data):

  • items [{end_user_uuid, staff_actor_uuid, identity_app_uuid, identity_app_name, status, status_reason, seated, group, group_slug, app_organization_uuid, actor_bound_at, actor_bound_by_user_uuid}], newest binding row first
  • total (matching bindings, all pages), limit, offset, staff_actor_uuid, identity_app_uuid No eligibility codes: read identity.end-user.actor-binding.get for one binding.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringNo——
organization_uuiduuidYes——
staff_actor_uuidstringNo——
identity_app_uuiduuidNo——
statusstringNo——
limitintegerNo——
offsetintegerNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
itemslistNo——
totalintegerNo——
limitintegerNo——
offsetintegerNo——
staff_actor_uuidstringNo——
identity_app_uuiduuidNo——
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.list",
  "initial_data": {
    "organization_uuid": "value"
  }
}