POST/api/auth/forgot-password

Запускает сброс пароля: если аккаунт с указанным email существует, на него приходит письмо со ссылкой для сброса.

Отправьте email аккаунта в поле `email`. Ответ `{"ok":true}` намеренно всегда одинаковый — независимо от того, существует ли аккаунт, — чтобы через этот эндпоинт нельзя было узнать, какие адреса зарегистрированы. Новый пароль затем устанавливается с помощью токена из письма через `POST /api/auth/reset-password`. Если поле `email` отсутствует или пусто, эндпоинт отвечает кодом 400 `VALIDATION_ERROR`. Для защиты от злоупотреблений число запросов на один IP-адрес ограничено (429 `RATE_LIMIT_EXCEEDED`).

Обзор

Вызов: POST /api/auth/forgot-password. Этот эндпоинт относится к группе «Аутентификация» API Zentor App. Он общедоступен и не требует аутентификации. Вызов идемпотентен: повторные вызовы с теми же данными возвращают тот же результат. Обязательные параметры: email (тело). Задокументированные случаи ошибок: 400 VALIDATION_ERROR. Пример ответа ниже показывает структуру успешного ответа в формате JSON.

Аутентификация и защита

Аутентификация не требуется

Идемпотентный: Да

Параметры

email(body, string, обязательно)— Email аккаунта

Пример запроса

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

Пример ответа

{"ok":true}

Коды ошибок

400 VALIDATION_ERROR — Поле `email` отсутствует или пусто.

Проверенное поведение

Ответ — 200 `{"ok":true}`, независимо от того, существует ли аккаунт; отсутствующее поле email возвращает 400 `VALIDATION_ERROR`.

Аутентификация

Связанные статьи

← Аутентификация