Appearance
identity.end-user.member-seat.assume ​
Take an end-user seat of your organization's identity app, as yourself (org members)
Take an end-user seat of one of your organization's identity apps, as yourself.
Caller: a human member of the organization (any role). The seat is linked to your console account, so there is no separate password: exchange your console token for an app end-user token at POST /api/auth/end-user/member-token, then use the app's end-user surfaces (for example the chat: buzz.session.issue).
Inputs:
- organization_uuid: owning organization (required)
- identity_app_uuid: the app (required)
Outputs: end_user_uuid, identity_app_uuid, member_user_uuid, status, seated, cap, consumed, free, created, revived, linked_existing, changed.
Refusals (failure_reason): identity_admin_requires_human (code MEMBER_PRINCIPAL_REQUIRED), MEMBER_USER_UNKNOWN, MEMBER_SEAT_NOT_ASSUMED (app not in this organization), MEMBER_NOT_IN_ORGANIZATION, MEMBER_EMAIL_REQUIRED, MEMBER_SEAT_EMAIL_CONFLICT, END_USER_DISABLED, ORG_NOT_SUBSCRIBED, SEAT_CAP_REACHED, ELIGIBILITY_UNAVAILABLE.
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 | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
end_user_uuid | uuid | No | — | — |
identity_app_uuid | uuid | No | — | — |
member_user_uuid | string | No | — | — |
status | string | No | — | — |
status_reason | string | No | — | — |
seated | boolean | No | — | — |
group_slug | string | No | — | — |
assigned_by_user_uuid | string | No | — | — |
assigned_at | string | No | — | — |
cap | integer | No | — | — |
consumed | integer | No | — | — |
free | integer | No | — | — |
changed | boolean | No | — | — |
created | boolean | No | — | — |
revived | boolean | No | — | — |
linked_existing | 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.member-seat.assume",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value"
}
}