Skip to content
Proud to collaborate with Microsoft for Startups

identity.user.query ​

List users belonging to an organization

List users belonging to an organization.

Inputs:

  • organization_uuid: Organization ID (required)
  • filters: dict with role, email (partial), username (partial) (optional)
  • limit: page size (optional)
  • offset: page offset (optional)

Outputs (terminal state_data):

  • users: list of user dicts
  • count: number of users returned (page count)
  • total: total matching users before pagination

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID
filtersdictNo—Filter criteria: role, email (partial), username (partial)
limitintegerNo—Maximum number of results to return
offsetintegerNo—Number of results to skip

Output Schema ​

FieldTypeRequiredDefaultDescription
userslistYes——
countintegerYes——
totalintegerYes——
organization_uuiduuidNo——
filtersdictNo——
limitintegerNo——
offsetintegerNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

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.user.query",
  "initial_data": {
    "organization_uuid": "value"
  }
}