Request a password reset email
POST
/v1/auth/request-password-reset
const url = 'https://example.com/v1/auth/request-password-reset';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"email":"hello@example.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/auth/request-password-reset \ --header 'Content-Type: application/json' \ --data '{ "email": "hello@example.com" }'Request Body required
Section titled “Request Body required ” Media type application/json
object
email
required
string format: email
Example generated
{ "email": "hello@example.com"}Responses
Section titled “ Responses ”If the email is registered, a reset link will be sent. Always returns 202 to prevent email enumeration.
Media type application/json
object
message
required
string
Example generated
{ "message": "example"}Malformed request body.
Media type application/json
object
code
required
Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).
string
message
required
Human-readable description of the error.
string
details
Optional additional context about the error.
object
key
additional properties
any
notices
Policy notices from determining Cedar rules, if applicable.
Array<string>
Example generated
{ "code": "example", "message": "example", "details": {}, "notices": [ "example" ]}