POST
/api/auth/reset-password/requestPublicRequest a password reset e-mail
E-mails a single-use password reset link (valid for one hour) to the address when an account exists for it. The response is the same whether or not the account exists, so addresses cannot be enumerated; service accounts are silently ignored. Rate limited per e-mail address.
operationId
post_api_auth_reset_password_requestAuthenticationAuthentication & permissionsPublic
Anyone — no credentials required
- Accepted credentials
- None required
Request body
Required — The body is parsed by the handler itself so its error format stays stable.
application/json
PasswordResetRequestUnknown keys are rejected.
| Property | Type | Description |
|---|---|---|
| email* | string (email) | E-mail address of the account |
JSONExample
"email""jane@example.com"
Responses
application/json
SuccessMessageResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string |
JSONExample
"success"true
"message""string"
Example request
bashcurl
curl -X POST 'https://auth.schemavaults.com/api/auth/reset-password/request' \
-H 'Content-Type: application/json' \
-d '{
"email": "jane@example.com"
}'