Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID
rolestringNo—Filter by role: member, admin, owner
limitintegerNo—Maximum number of results to return
offsetintegerNo—Number of results to skip

Output Schema ​

FieldTypeRequiredDefaultDescription
userslistYes——
countintegerYes——
organization_uuiduuidNo——
rolestringNo——
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.membership.query-by-org",
  "initial_data": {
    "organization_uuid": "value"
  }
}