Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-connection
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization that owns the connection
connection_uuiduuidYes—UUID of the connection to disconnect
actorstringNo—ID of the user/agent initiating the disconnect

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input
connection_uuiduuidNo—Connection UUID echoed from input
actorstringNo—Actor echoed from input
initiated_atstringNo—ISO-8601 timestamp when the disconnect began
initiated_bystringNo—Actor that initiated the disconnect
disconnectedbooleanNo—True when the connection was soft-deleted (or already was)
already_deletedbooleanNo—True when the row was already soft-deleted before this run
deleted_atstringNo—ISO-8601 timestamp of the soft-delete
completed_atstringNo—ISO-8601 timestamp of overall completion
failure_reasonstringNo—Failure reason on the failed branch
failure_typestringNo—Failure category
failed_actionstringNo—Action method that raised
failed_at_statestringNo—State the workflow was in when it failed
failed_atstringNo—ISO-8601 timestamp of failure
errorstringNo—Engine-stamped exception message on the failure path
error_typestringNo—Engine-stamped exception class name on the failure path
failed_layerstringNo—Engine-stamped framework layer that raised
failed_stepstringNo—Engine-stamped action or state where the failure occurred

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—disconnectDisconnect request received
completedNoYesYes—Connection disconnected
failedNoYesNo—Disconnect workflow failed

State Diagram ​

Transitions ​

FromActionToDescription
initiateddisconnectcompleted—
* (any state)failfailed—

Business Errors ​

CodeMessage Template
CONNECTION_DISCONNECT_FAILEDFailed 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"
  }
}