Request reset email

For a valid email, responds with generic accepted message whether or not an active verified identity exists. Queues email only for verified identities. Reset link targets admin ?reset_token=... . Limit 5 per connection IP per minute.

Authentication

No bearer token required. This does not remove validation or rate limits.

Parameters

No path or query parameters.

Request

Example JSON body

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

{
  "$ref": "#/components/schemas/ResetRequest"
}

Example request

Replace synthetic identifiers and credentials. Example dates, coordinates, revisions, and IDs are not production defaults. Read the workflow guide before making a write.

curl --request POST 'https://route-api.okok.space/api/v1/auth/password-reset/request' \
  --header 'Content-Type: application/json' \
  --data '{"email":"dispatcher@example.com"}' \
  --output response.bin

Responses

Examples illustrate the documented shape; optional fields and current state can differ. JSON extraction/body-limit errors may be plain text.

202 · Successful response.

application/json

{
  "message": "example"
}

{
  "$ref": "#/components/schemas/Message"
}

400 · Axum extraction rejects invalid JSON/type, oversized body, or malformed UUID before the domain handler. These responses may be text/plain rather than the domain Error object.

text/plain

Binary response. Save the returned bytes to a file; do not parse as JSON.

413 · Axum extraction rejects invalid JSON/type, oversized body, or malformed UUID before the domain handler. These responses may be text/plain rather than the domain Error object.

text/plain

Binary response. Save the returned bytes to a file; do not parse as JSON.

415 · Axum extraction rejects invalid JSON/type, oversized body, or malformed UUID before the domain handler. These responses may be text/plain rather than the domain Error object.

text/plain

Binary response. Save the returned bytes to a file; do not parse as JSON.

422 · Domain validation failure; names are trimmed and emails normalized.

application/json

{
  "error": {
    "code": "validation",
    "message": "Domain validation failure; names are trimmed and emails normalized."
  }
}

{
  "$ref": "#/components/schemas/Error"
}

429 · Connection-address request limit reached. Retry after the stated interval.

application/json

{
  "error": {
    "code": "rate_limited",
    "message": "Connection-address request limit reached. Retry after the stated interval."
  }
}

{
  "$ref": "#/components/schemas/Error"
}

503 · Required persistence or credential operation unavailable.

application/json

{
  "error": {
    "code": "unavailable",
    "message": "Required persistence or credential operation unavailable."
  }
}

{
  "$ref": "#/components/schemas/Error"
}