Skip to content
Proud to collaborate with Microsoft for Startups

identity.organization.query ​

List organizations the authenticated user is a member of

List organizations the authenticated user is a member of.

Inputs:

  • actor: caller's cognito_sub or uuid (required)
  • organization_uuid: filter to a single org (optional)
  • limit: page size (optional)
  • offset: page offset (optional)

Outputs (terminal state_data):

  • organizations: list of org dicts (uuid, name, domain, region, role)
  • count: number of orgs returned (page count)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes—Caller cognito_sub or uuid
organization_uuiduuidNo—Filter to a single organization by public UUID
limitintegerNo—Maximum number of results to return
offsetintegerNo—Number of results to skip

Output Schema ​

FieldTypeRequiredDefaultDescription
organizationslistYes——
countintegerYes——
actorstringNo——
organization_uuiduuidNo——
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.organization.query",
  "initial_data": {
    "actor": "value"
  }
}