Skip to content

Delete User

Client SDK
Backend API
Mobile approve
SSO
Sub-journey

Deletes a user profile from Mosaic

Description

This step is used to delete a user profile from Mosaic. It can be used in account deletion flows, user privacy requests, or administrative user cleanup.

The user context for the step may be provided implicitly by the journey if the user is already authenticated; otherwise, a user identifier must be specified in the step configuration. The user can be located by any supported identifier (for example, email, phone number, username, external user ID, or a custom identifier, if configured for B2C users in your tenant). If the user is found, the step deletes the user profile.

If the step is successfully completed, the journey continues. If it fails, the journey proceeds according to the configured failure behavior.

Configuration

FieldDescription
User auth stateIndicates if the user has authenticated in this journey. If the user is authenticated (default), the user context is provided implicitly by the journey. If not, a user identifier must be configured.
IdentifiersOnly configured if the journey doesn't authenticate the user before invoking this step. Can be an external user ID, email, phone number, username, or a custom identifier, if configured for B2C users in your tenant.
Identifier valueUser identifier, specified as an expression.
Error output variableName of the variable that stores any errors returned by the step.
Failure behaviorDetermines the behavior in case of failure: proceed to a failure branch of the control flow (default) or abort the journey.

Example

Suppose a signed-in user requests account deletion. After confirming the request (for example, using a step that performs strong authentication), you can use Delete User to remove the user profile from Mosaic.

If the step succeeds, you can proceed to a Display information step to confirm the deletion.