generateResetPasswordTokenWorkflow - Medusa Core Workflows Reference

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

This workflow generates a reset password token for a user. It's used by the Generate Reset Password Token for Admin and Generate Reset Password Token for Customer API Routes.

The workflow emits the auth.password_reset event, which you can listen to in a subscriber. Follow this guide to learn how to handle this event.

You can use this workflow within your customizations or your own custom workflows, allowing you to generate reset password tokens within your custom flows.

Examples#

Steps#

Input#

Output#

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.

{
  entity_id, // The identifier of the user or customer. For example, an email address.
  actor_type, // The type of actor. For example, "customer", "user", or custom.
  token, // The generated token.
}