Skip to content
Proud to collaborate with Microsoft for Startups

identity.end-user.delete ​

Soft-delete an end-user for a customer app (frees the seat)

Soft-delete an end-user for a customer app (frees the seat; row is retained).

Inputs:

  • actor: Cognito sub or user UUID
  • organization_uuid: owning organization (required)
  • identity_app_uuid: the app's identity tenant (required)
  • end_user_uuid: the end-user to delete (required)

Outputs (terminal state_data):

  • end_user_uuid, status, deleted (always True)

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
identity_app_uuiduuidYes——
end_user_uuiduuidYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
end_user_uuiduuidYes——
statusstringYes——
deletedbooleanYes——
actorstringNo——
identity_app_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—validate—
persistingNoNo—complete—
validatingNoNo—persist—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedvalidatevalidating—
validatingpersistpersisting—
persistingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "identity.end-user.delete",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "end_user_uuid": "value"
  }
}