identity.app.set-workflow-eligibility

Mark a workflow type end-user eligible for this app (or withdraw it)

Turn a workflow type on or off for this app's end-users.

Inputs:

• actor, organization_uuid, identity_app_uuid (required)
• workflow_type: the library workflow to enable/disable (required)
• enabled: true to add the override, false to withdraw it (required)

Outputs:

• workflow_type, enabled, changed (false when already in that state)
• overrides: the app's full override list after the change
• unexposed: compositions un-exposed because withdrawing the override made them invalid — [{composition_uuid, version, ineligible_steps}]. Empty on enable.

Withdrawing an override re-validates every exposed composition; any that now fails is un-exposed, so turning a type off actually takes access away.

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	—	—
workflow_type	string	Yes	—	—
enabled	boolean	Yes	—	—

Output Schema

Field	Type	Required	Default	Description
identity_app_uuid	uuid	No	—	—
workflow_type	string	No	—	—
enabled	boolean	No	—	—
changed	boolean	No	—	—
overrides	list	No	—	—
unexposed	list	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.set-workflow-eligibility",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "workflow_type": "value"
  }
}