identity.end-user.member-seat.release ​
Release an org member's end-user seat in an identity app (self, or org admins for others)
Release a member end-user seat: it stops counting against the app's seat cap and every end-user token issued for it is invalidated.
Caller: the member (own seat), or an org ADMIN/OWNER naming member_user_uuid. The row is kept (status suspended, status_reason seat_released) so assuming again revives the same end user and its data.
Inputs: organization_uuid, identity_app_uuid (required), member_user_uuid (admins). Outputs: the seat view plus released, changed, cap, consumed, free. Refusals: MEMBER_PRINCIPAL_REQUIRED, MEMBER_ADMIN_REQUIRED, MEMBER_NOT_IN_ORGANIZATION, MEMBER_SEAT_NOT_ASSUMED.
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 | — | — |
member_user_uuid | string | No | — | Another member's seat to release (org admins only); omit for your own |
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 | — | — |
released | 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.release",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value"
}
}