Appearance
identity.end-user.admit ​
Login-time seat gate: admit/deny an end-user and seat them
Login-time seat gate: decide whether an end-user may sign in, and seat them.
Inputs:
- identity_app_uuid: the app's identity tenant (required)
- email: the end-user's email (required)
- external_sub: Cognito sub to bind on first login (optional)
- actor: the calling principal (optional)
Outputs (terminal state_data):
- admitted (bool), reason, created, end_user_uuid, seated, cap, consumed, free
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
identity_app_uuid | uuid | Yes | — | — |
email | string | Yes | — | — |
external_sub | string | No | — | — |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
admitted | boolean | Yes | — | — |
reason | string | Yes | — | — |
created | boolean | No | — | — |
end_user_uuid | uuid | No | — | — |
seated | boolean | No | — | — |
cap | integer | No | — | — |
consumed | integer | No | — | — |
free | integer | No | — | — |
identity_app_uuid | uuid | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | 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.admit",
"initial_data": {
"identity_app_uuid": "value",
"email": "value"
}
}