identity.app.expose-virtual-workflow

Expose a virtual workflow to an app's end-users (eligibility-checked)

Expose a virtual workflow (composition_uuid + version) to an app's end-users.

Inputs:

• actor, organization_uuid (required)
• identity_app_uuid: the app (required)
• composition_uuid, version: the SavedComposition to expose (required)

Outputs: exposed (bool), composition_uuid, version, step_count, and on refusal either ineligible_steps (types this app may not run at all) or unsealed_steps (types the app overrode, but the composition feeds them caller input — [{step, workflow_type, tainted_params}]). The two are different fixes: enable the type, versus stop passing it end-user input.

Overview

Property	Value
Workflow type	Atomic
Library	App-identity
Version	1.0

Input Schema

Field	Type	Required	Default	Description
actor	string	Yes	—	—
organization_uuid	uuid	Yes	—	—
identity_app_uuid	uuid	Yes	—	—
composition_uuid	uuid	Yes	—	—
version	integer	Yes	—	—

Output Schema

Field	Type	Required	Default	Description
exposed	boolean	Yes	—	—
composition_uuid	uuid	No	—	—
version	integer	No	—	—
step_count	integer	No	—	—
ineligible_steps	list	No	—	—
unsealed_steps	list	No	—	—
unscoped_inputs	list	No	—	—
identity_app_uuid	uuid	No	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
reason	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "identity.app.expose-virtual-workflow",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "composition_uuid": "value"
  }
}