Skip to content
Proud to collaborate with Microsoft for Startups

identity.composition.set-audience ​

Set which access groups may invoke an exposed composition

Set who can call an exposed composition: All app users | Selected groups | Nobody.

Inputs:

  • actor: Cognito sub or user UUID (required)
  • organization_uuid: owning organization — tenant check (required)
  • identity_app_uuid: the app's identity tenant (required)
  • composition_uuid: the exposed composition's lineage uuid (required)
  • audience: "all" | "groups" | "none" (required)
  • groups: access-group slugs to grant — required and non-empty when audience="groups"

Outputs (terminal state_data):

  • composition_uuid, capability, audience, groups (the slugs granted), managed
  • reopened: True when this call took the composition from managed → unmanaged (a silent re-open to all end-users); audited as composition.audience.reopened

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
identity_app_uuiduuidYes——
composition_uuidstringYes——
audiencestringYes——
groupslistNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
composition_uuidstringNo——
capabilitystringNo——
audiencestringNo——
groupslistNo——
managedbooleanNo——
reopenedbooleanNo——
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.composition.set-audience",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "composition_uuid": "value"
  }
}