Skip to content
Proud to collaborate with Microsoft for Startups

identity.user.delete ​

Request account deletion — sends email to ops; does not delete

Request account deletion — opens a support ticket via email; does not delete.

Inputs:

  • actor: Cognito sub or user UUID of the requesting user (required)
  • confirm: Must be true (required)
  • confirmation_phrase: Must equal 'DELETE MY ACCOUNT' exactly (required)
  • reason: Optional free-text reason to include in the request

Outputs (terminal state_data):

  • user_uuid
  • requested: True
  • requested_at: ISO timestamp
  • email_dispatched: best-effort bool
  • email_workflow_ref: child workflow id when dispatch was started
  • dispatch_error: best-effort dispatch error when the child could not be started

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
confirmbooleanYes——
confirmation_phrasestringYes——
reasonstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
user_uuidstringYes——
requestedbooleanYes——
requested_atstringYes——
email_dispatchedbooleanYes——
email_workflow_refstringNo——
dispatch_errorstringNo——
reasonstringNo——
confirmbooleanNo——
confirmation_phrasestringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "identity.user.delete",
  "initial_data": {
    "actor": "value",
    "confirm": true,
    "confirmation_phrase": "value"
  }
}