identity.membership.query-by-org ​
Return user profiles with role for all active members of an organization
Get user profiles with role for all active members of an organization.
Inputs:
- organization_uuid: Organization ID (required)
- organization_uuid: Organization UUID (optional — echoed in output)
- role: Filter by role (optional)
- limit: page size (optional)
- offset: page offset (optional)
Outputs (terminal state_data):
- users: list of user-profile dicts
- organization_uuid: UUID | None
- count: number of users returned (page count)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
role | string | No | — | Filter by role: member, admin, owner |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | Number of results to skip |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
users | list | Yes | — | — |
count | integer | Yes | — | — |
organization_uuid | uuid | No | — | — |
role | string | No | — | — |
limit | integer | No | — | — |
offset | integer | 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.query-by-org",
"initial_data": {
"organization_uuid": "value"
}
}