Forgot Password

POST

/auth/forgot-password

curl --request POST \
  --url https://example.com/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]" }'

Request a password reset. Always returns 202 regardless of whether the email exists (no account enumeration). If it does, a single-use reset link is emailed.

Request Body^required

Media typeapplication/json

ForgotPasswordRequest

object

email

required

Email

string format: email

Example^generated

{
  "email": "[email protected]"
}

Responses

202

Successful Response

Media typeapplication/json

Response Forgot Password Auth Forgot Password Post

object

key

additional properties

any

Example^generated

{}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}