Endpoint catalog
requestOfficialPasswordReset
POST /api/v1/auth/password/reset/request
POST /api/v1/auth/password/reset/request
- operationId:
requestOfficialPasswordReset - Stability: stable
- Authentication: None
- Idempotency: required
Parameters
This operation declares no parameters.
Request body
- Required: Yes
- Schema:
#/components/schemas/PublicPasswordResetRequest
Responses and errors
| Status | Description | Schema |
|---|---|---|
200 | Successful response | #/components/schemas/PublicPasswordOperationResponse |
400 | Request does not match the public contract | #/components/schemas/PublicErrorResponse |
401 | Authentication failed | #/components/schemas/PublicErrorResponse |
403 | Insufficient authorization scope | #/components/schemas/PublicErrorResponse |
404 | Public resource not found | #/components/schemas/PublicErrorResponse |
409 | Idempotency or state conflict | #/components/schemas/PublicErrorResponse |
429 | Rate limited | #/components/schemas/PublicErrorResponse |
Rate limiting
The spec declares a 429 response.
The Retry-After header is not declared by the spec.
- Top-level shape:
{ data: object }
Success response schema
{
"$ref": "#/components/schemas/PublicPasswordOperationResponse"
}
Error response schema
{
"$ref": "#/components/schemas/PublicErrorResponse"
}
Generated from the verified public-only OpenAPI artifact; no speculative request example is provided.