Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
identity_app_uuiduuidYes——
statusstringNo——
groupstringNo——
principal_kindstringNo——
limitintegerNo——
offsetintegerNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
itemslistYes——
totalintegerYes——
capintegerNo——
consumedintegerNo——
freeintegerNo——
actorstringNo——
identity_app_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
reasonstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

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"
  }
}