Skip to content
Proud to collaborate with Microsoft for Startups

identity.app.query ​

List an organization's identity apps (or one app's detail)

List an organization's identity apps, or one app's detail.

Inputs:

  • actor: Cognito sub or user UUID
  • organization_uuid: owning organization (required)
  • identity_app_uuid: narrow to a single app's detail (optional)

Outputs (terminal state_data):

  • items: list of UUID-keyed dicts (app_uuid, name, status, mode, project_uuid, exposed_virtual_count [, exposed_virtual_workflows, dev_allowed_emails, allowed_email_domains, client_uuid, client_id, redirect_uris, token_ttls, policy, branding])
  • total: number of apps returned

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
identity_app_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
itemslistYes——
totalintegerYes——
actorstringNo——
identity_app_uuiduuidNo——
foundbooleanNo——
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.app.query",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value"
  }
}