Request password reset email
POST
/auth/resetRequest body
application/jsonemailstringResponses
200Request successful
400Bad Request (invalid input)
messagestringrequirederrorsopenApiErrorItem[]requiredmin items 1
Show propertiesHide properties
Array of
openApiErrorItemopenApiErrorItemtracestring | nullrequireddeprecatedAlways null. Deprecated; may be removed in a future release.
413Payload Too Large (JSON body exceeds 400kb limit)
messagestringrequirederrorsopenApiErrorItem[]requiredShow propertiesHide properties
Array of
openApiErrorItemopenApiErrorItemtracestring | nullrequireddeprecatedAlways null. Deprecated; may be removed in a future release.
500Internal server error
messagestringrequiredtracestring | nullrequireddeprecatedAlways null. Deprecated; may be removed in a future release.
Request
curl -X POST "/auth/reset" \
-H "Content-Type: application/json" \
-d '{
"email": "my-email@example.com"
}'const response = await fetch("/auth/reset", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"email": "my-email@example.com"
})
});Response
Request successful
{
"message": "request.body should have required property 'XYZ'",
"errors": [
null
],
"trace": null
}{
"message": "Payload Too Large",
"errors": [
null
],
"trace": null
}{
"message": "Internal Server Error",
"trace": null
}