POST/api/auth/forgot-password

Startet das Zurücksetzen eines Passworts: Existiert ein Konto mit der angegebenen E-Mail-Adresse, erhält es eine E-Mail mit einem Link zum Zurücksetzen.

Senden Sie die E-Mail-Adresse des Kontos im Feld `email`. Die Antwort `{"ok":true}` ist bewusst immer gleich – unabhängig davon, ob ein Konto existiert –, damit sich über diesen Endpunkt nicht ermitteln lässt, welche Adressen registriert sind. Das neue Passwort wird anschließend mit dem Token aus der E-Mail über `POST /api/auth/reset-password` gesetzt. Fehlt das Feld `email` oder ist es leer, antwortet der Endpunkt mit 400 `VALIDATION_ERROR`. Zum Schutz vor Missbrauch ist die Zahl der Anfragen je IP-Adresse begrenzt (429 `RATE_LIMIT_EXCEEDED`).

Überblick

Aufruf: POST /api/auth/forgot-password. Der Endpunkt gehört zur Gruppe „Authentifizierung“ der API von Zentor App. Er ist öffentlich erreichbar und benötigt keine Authentifizierung. Der Aufruf ist idempotent: Wiederholte Aufrufe mit denselben Angaben liefern dasselbe Ergebnis. Pflichtparameter: email (Body). Dokumentierte Fehlerfälle: 400 VALIDATION_ERROR. Die Beispielantwort unten zeigt den Aufbau einer erfolgreichen Antwort im JSON-Format.

Auth & Absicherung

Keine Authentifizierung erforderlich

Idempotent: Ja

Parameter

email(body, string, erforderlich)— E-Mail-Adresse des Kontos

Beispiel-Request

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

Beispiel-Response

{"ok":true}

Fehlercodes

400 VALIDATION_ERROR — Das Feld `email` fehlt oder ist leer.

Geprüftes Verhalten

Die Antwort ist 200 `{"ok":true}`, unabhängig davon, ob das Konto existiert; ein fehlendes E-Mail-Feld liefert 400 `VALIDATION_ERROR`.

Authentifizierung

Verwandte Artikel

← Authentifizierung