Sign in

v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Client

Send password reset (code or link based on config)

Send password reset email using the method configured in auth settings (resetPasswordMethod). When method is 'code', sends a 6-digit numeric code for two-step flow. When method is 'link', sends a browser reset link that goes through an InsForge backend endpoint first. Prevents user enumeration by returning success even if email doesn't exist.

post/api/auth/email/send-reset-password

Request body

emailstring email required
redirectTostring uri

Used for link-based password reset. The email link always opens an InsForge backend endpoint first; InsForge then redirects the browser to this URL with the reset token in the query string. This URL must be included in allowedRedirectUrls. Recommended: use your app's dedicated reset-password page.

Example request

{
  "email": "user@example.com"
}

Response

Password reset email sent (if email exists). Message varies based on configured method.

successboolean
messagestring

Example response

{
  "message": "If your email is registered, we have sent you a password reset code/link. Please check your inbox."
}