identity.end-user.query ​
List end-users for an app's identity tenant (paged)
List end-users for an app's identity tenant (paged, newest-first).
Inputs:
- actor: Cognito sub or user UUID (required)
- organization_uuid: owning organization (required)
- identity_app_uuid: the app's identity tenant (required)
- status: optional filter — active | disabled | suspended
- principal_kind: optional filter — human | staff_actor
- limit: optional page size (default 100)
- offset: optional page offset (default 0)
Outputs (terminal state_data):
- items: list of {end_user_uuid, email (null for a staff actor), status, seated, group, email_verified, mfa_enabled, first_login_at, principal_kind, staff_actor_uuid, status_reason, actor_bound_at, actor_bound_by_user_uuid}
- total, cap, consumed, free
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
status | string | No | — | — |
group | string | No | — | — |
principal_kind | string | No | — | — |
limit | integer | No | — | — |
offset | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
items | list | Yes | — | — |
total | integer | Yes | — | — |
cap | integer | No | — | — |
consumed | integer | No | — | — |
free | integer | No | — | — |
actor | string | No | — | — |
identity_app_uuid | uuid | 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.query",
"initial_data": {
"actor": "value",
"organization_uuid": "value",
"identity_app_uuid": "value"
}
}