Appearance
identity.membership.remove ​
Remove a member from an organization
Remove a member from an organization.
Inputs:
- membership_uuid: Membership UUID to remove (required)
- organization_uuid: Organization ID for tenant check (required)
- actor: Actor Cognito sub or user UUID (required)
- force: Allow removing the last owner (optional, default False)
Outputs (terminal state_data):
- membership_uuid
- removed: bool
- was_last_owner: bool
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
membership_uuid | uuid | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
actor | string | Yes | — | — |
force | boolean | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
membership_uuid | string | Yes | — | — |
removed | boolean | Yes | — | — |
was_last_owner | boolean | Yes | — | — |
member_seats_suspended | list | No | — | — |
reason | string | No | — | — |
organization_uuid | uuid | No | — | — |
actor | string | No | — | — |
force | boolean | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | 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.membership.remove",
"initial_data": {
"membership_uuid": "value",
"organization_uuid": "value",
"actor": "value"
}
}