Appearance
identity.end-user.bind-actor ​
Bind a Staff actor to an end-user seat of an identity app (human admin only)
Bind a Staff actor to an end-user seat of an identity app (human org admin only).
Inputs:
- organization_uuid: owning organization — tenant check (required)
- identity_app_uuid: the app (required)
- staff_actor_uuid: the Staff actor to seat (required)
- group_slug: access group (optional, default "member"; never "owner")
- app_organization_uuid: workspace to add the actor to (optional)
- workspace_group_slug: workspace role (optional; never "owner")
- reason: why (required, audited)
Outputs (terminal state_data):
- end_user_uuid, staff_actor_uuid, identity_app_uuid, status, seated, cap, consumed, free, group_slug, app_organization_uuid, workspace_group_slug, created, revived, changed
Refusals (failure_reason): identity_admin_requires_human (code HUMAN_PRINCIPAL_REQUIRED), ACTOR_INACTIVE, ACTOR_NOT_ACTIVE, ACTOR_IDENTITY_MISSING, ACTOR_TOKEN_REQUIRED, ACTOR_SEAT_NOT_PAID, ACTOR_END_USER_NOT_BOUND, ELIGIBILITY_UNAVAILABLE, OWNER_ROLE_FORBIDDEN_FOR_STAFF_ACTOR, ORG_NOT_SUBSCRIBED, SEAT_CAP_REACHED.
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 | — | — |
group_slug | string | No | — | — |
app_organization_uuid | uuid | No | — | — |
workspace_group_slug | string | No | — | — |
reason | string | Yes | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
end_user_uuid | uuid | No | — | — |
staff_actor_uuid | string | No | — | — |
identity_app_uuid | uuid | No | — | — |
status | string | No | — | — |
seated | boolean | No | — | — |
cap | integer | No | — | — |
consumed | integer | No | — | — |
free | integer | No | — | — |
group_slug | string | No | — | — |
app_organization_uuid | uuid | No | — | — |
workspace_group_slug | string | No | — | — |
created | boolean | No | — | — |
revived | boolean | No | — | — |
changed | boolean | 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.bind-actor",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value",
"staff_actor_uuid": "value",
"reason": "value"
}
}