deleteUsersWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more users. It's used by other workflows like removeUserAccountWorkflow. If you use this workflow directly, you must also remove the association to the auth identity using the setAuthAppMetadataStep. Learn more about auth identities in this documentation.

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

Examples#

Steps#

Input#

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

[{
  id, // The ID of the user
}]