identity.app.unexpose-virtual-workflow ​
Revoke a virtual workflow's exposure to an app's end-users
Un-expose (revoke) a virtual workflow so an app's end-users can no longer invoke it.
Inputs:
- actor, organization_uuid (required)
- identity_app_uuid: the app (required)
- composition_uuid: the SavedComposition lineage uuid to revoke (required)
- version: optional — omit to remove ALL exposed versions; pass to remove one
Outputs: unexposed (bool), composition_uuid, removed_count, remaining_versions, grants_cleared
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 | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
unexposed | boolean | Yes | — | — |
composition_uuid | uuid | No | — | — |
removed_count | integer | No | — | — |
remaining_versions | list | No | — | — |
grants_cleared | integer | 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 ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.app.unexpose-virtual-workflow",
"initial_data": {
"actor": "value",
"organization_uuid": "value",
"identity_app_uuid": "value",
"composition_uuid": "value"
}
}