Skip to content
Proud to collaborate with Microsoft for Startups

data.identity.end-user.soft-delete ​

Disable or soft-delete an end-user (frees the seat)

Disable or soft-delete an EndUser (idempotent).

Input: end_user_uuid (required), mode (required: "disable"|"delete"), actor (optional). Output: end_user_uuid, status, mode, persisted.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
end_user_uuiduuidYes——
modestringYes——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
end_user_uuiduuidYes——
statusstringYes——
modestringYes——
persistedbooleanYes——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeDisable/soft-delete end-user
completedNoYesYes—Persisted
failedNoYesNo—Persist failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

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

{
  "workflow_type": "data.identity.end-user.soft-delete",
  "initial_data": {
    "end_user_uuid": "value",
    "mode": "value"
  }
}