Admin Api Keys
Admin Campaigns
Admin Claims
Admin Collections
Admin Currencies
Admin Customer Groups
Admin Customers
Admin Draft Orders
Admin Exchanges
Admin Fulfillment Providers
Admin Fulfillment Sets
Admin Fulfillments
Admin Gift Cards
Admin Inventory Items
Admin Invites
Admin Notifications
Admin Order Edits
Admin Orders
Admin Payment Collections
Admin Payments
Admin Plugins
Admin Price Lists
Admin Price Preferences
Admin Product Categories
Admin Product Tags
Admin Product Types
Admin Product Variants
Admin Products
Admin Promotions
Admin Refund Reasons
Admin Regions
Admin Reservations
Admin Return Reasons
Admin Returns
Admin Sales Channels
Admin Shipping Options
Admin Shipping Profiles
Admin Stock Locations
Admin Store Credit Accounts
Admin Stores
Admin Tax Providers
Admin Tax Rates
Admin Tax Regions
Admin Transaction Groups
Admin Uploads
Admin Users
Admin Workflows Executions
Store Auth
- POST
  Set Authentication Session
- DEL
  Delete Authentication Session
- POST
  Refresh Authentication Token
- POST
  Authenticate Customer
- POST
  Validate Authentication Callback
- POST
  Retrieve Registration JWT Token
- POST
  Generate Reset Password Token for Customer
- POST
  Reset a Customer's Password
Admin Auth
Store Carts
Store Collections
Store Currencies
Store Customers
Store Gift Cards
Store Orders
Store Payment Collections
Store Payment Providers
Store Product Categories
Store Product Tags
Store Product Types
Store Products
Store Regions
Store Return Reasons
Store
Store Shipping Options
Store Store Credit Accounts
Admin Algolia
Admin Attributes
Admin Commission
Admin Configuration
Admin Order Sets
Admin Requests
Admin Return Request
Admin Reviews
Admin Sellers
Auth
Store Return Request
Store Reviews
Store Sellers
Store Wishlist
Vendor Attributes
Vendor Campaigns
Vendor Commission
Vendor Configuration
Vendor Customer Groups
Vendor Customers
Vendor Fulfillment Providers
Vendor Fulfillment Sets
Vendor Inventory Items
Vendor Invites
Vendor Current Member
Vendor Members
Vendor Notifications
Vendor Orders
Vendor Payout Account
Vendor Payouts
Vendor Price Lists
Vendor Price Preferences
Vendor Product Categories
Vendor Product Collections
Vendor Product Tags
Vendor Product Types
Vendor Products
Vendor Promotions
Vendor Regions
Vendor Requests
Vendor Reservations
Vendor Return Requests
Vendor Returns
Vendor Sales Channels
Vendor Sellers
Vendor Onboarding
Vendor Reviews
Vendor Shipping Options
Vendor Shipping Profiles
Vendor Statistics
Vendor Stock Locations
Vendor Stores

Store Auth

Generate Reset Password Token for Customer

Generate a reset password token for a customer. This API route doesn’t reset the customer password or send them the reset instructions in a notification.

Instead, This API route emits the auth.password_reset event, passing it the token as a payload. You can listen to that event in a subscriber as explained in this guide, then send the customer a notification. The notification is sent using a Notification Module Provider, and it should have a URL that accepts a token query parameter, allowing the customer to reset their password from the storefront.

Use the generated token to update the customer’s password using the Reset Password API route.

POST

auth

customer

{auth_provider}

reset-password

import Medusa from "@medusajs/js-sdk"

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

sdk.auth.resetPassword(
  "customer",
  "emailpass",
  {
    identifier: "customer@gmail.com"
  }
)
.then(() => {
  // user receives token
})

This response does not have an example.

Path Parameters

auth_provider

string

required

The provider used for authentication.

Example:

"emailpass"

Body

application/json · identifier · object

The customer's identifier for the selected auth provider. For example, for the emailpass auth provider, the value is the customer's email.

Response

201

Retrieve Registration JWT Token Reset a Customer's Password

import Medusa from "@medusajs/js-sdk"

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

sdk.auth.resetPassword(
  "customer",
  "emailpass",
  {
    identifier: "customer@gmail.com"
  }
)
.then(() => {
  // user receives token
})

This response does not have an example.

API Documentation

Path Parameters

Body

Response