POST/api/auth/forgot-password

Rozpoczyna resetowanie hasła: jeśli istnieje konto z podanym adresem e-mail, otrzymuje e-mail z linkiem do zresetowania.

Wyślij adres e-mail konta w polu `email`. Odpowiedź `{"ok":true}` jest zawsze taka sama celowo – niezależnie od tego, czy konto istnieje – aby nie można było za pomocą tego punktu końcowego ustalić, które adresy są zarejestrowane. Nowe hasło ustawia się następnie za pomocą tokenu z e-maila przez `POST /api/auth/reset-password`. Jeśli pole `email` jest brakujące lub puste, punkt końcowy odpowiada kodem 400 `VALIDATION_ERROR`. W celu ochrony przed nadużyciami liczba żądań na adres IP jest ograniczona (429 `RATE_LIMIT_EXCEEDED`).

Przegląd

Wywołanie: POST /api/auth/forgot-password. Ten endpoint należy do grupy „Uwierzytelnianie” API Zentor App. Jest publicznie dostępny i nie wymaga uwierzytelniania. Wywołanie jest idempotentne: powtarzane wywołania z tymi samymi danymi zwracają ten sam wynik. Parametry wymagane: email (body). Udokumentowane przypadki błędów: 400 VALIDATION_ERROR. Poniższa przykładowa odpowiedź pokazuje strukturę udanej odpowiedzi w formacie JSON.

Uwierzytelnianie i zabezpieczenia

Uwierzytelnianie nie jest wymagane

Idempotentny: Tak

Parametry

email(body, string, wymagane)— Adres e-mail konta

Przykładowe żądanie

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

Przykładowa odpowiedź

{"ok":true}

Kody błędów

400 VALIDATION_ERROR — Pole `email` jest brakujące lub puste.

Zweryfikowane zachowanie

Odpowiedź to 200 `{"ok":true}`, niezależnie od tego, czy konto istnieje; brakujące pole e-mail zwraca 400 `VALIDATION_ERROR`.

Uwierzytelnianie

Powiązane artykuły

← Uwierzytelnianie