Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

removeUserAccountWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the removeUserAccountWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow deletes a user and remove the association to its auth identity. It's used by the Delete User Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to delete users within your custom flows.

Source Code

Examples#

Steps#

deleteUsersWorkflow

useRemoteQueryStep

setAuthAppMetadataStep

Workflow Hook

Step conditioned by when

Input#

RemoveUserAccountWorkflowInputRemoveUserAccountWorkflowInput
The data to remove a user account.
userIdstring
The ID of the user to remove.

Output#

stringstring
stringstring
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵