connection.disconnect ​
Disconnects a cloud provider connection: scrubs its secrets and soft-deletes the CloudConnection record
Workflow for disconnecting (soft-deleting) a cloud provider connection.
States: initiated → completed any → failed
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-connection |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the organization that owns the connection |
connection_uuid | uuid | Yes | — | UUID of the connection to disconnect |
actor | string | No | — | ID of the user/agent initiating the disconnect |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input |
connection_uuid | uuid | No | — | Connection UUID echoed from input |
actor | string | No | — | Actor echoed from input |
initiated_at | string | No | — | ISO-8601 timestamp when the disconnect began |
initiated_by | string | No | — | Actor that initiated the disconnect |
disconnected | boolean | No | — | True when the connection was soft-deleted (or already was) |
already_deleted | boolean | No | — | True when the row was already soft-deleted before this run |
deleted_at | string | No | — | ISO-8601 timestamp of the soft-delete |
completed_at | string | No | — | ISO-8601 timestamp of overall completion |
failure_reason | string | No | — | Failure reason on the failed branch |
failure_type | string | No | — | Failure category |
failed_action | string | No | — | Action method that raised |
failed_at_state | string | No | — | State the workflow was in when it failed |
failed_at | string | No | — | ISO-8601 timestamp of failure |
error | string | No | — | Engine-stamped exception message on the failure path |
error_type | string | No | — | Engine-stamped exception class name on the failure path |
failed_layer | string | No | — | Engine-stamped framework layer that raised |
failed_step | string | No | — | Engine-stamped action or state where the failure occurred |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | disconnect | Disconnect request received |
completed | No | Yes | Yes | — | Connection disconnected |
failed | No | Yes | No | — | Disconnect workflow failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | disconnect | completed | — |
* (any state) | fail | failed | — |
Business Errors ​
| Code | Message Template |
|---|---|
CONNECTION_DISCONNECT_FAILED | Failed to disconnect connection {connection_uuid}: |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "connection.disconnect",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value"
}
}