Установка нового пароля

Метод используется для завершения процедуры сброса пароля пользователя к Панели управления Клиента. Перед вызовом этого метода нужно последовательно выполнить следующие шаги:

Для успешной установки нового пароля должны выполняться все следующие условия:

Срок действия токена еще не истек.
Токен прошел валидацию.
Токен еще не использовался.

В результате для пользователя устанавливается новый пароль к Панели управления Клиента и метод возвращает следующую информацию:

Если MFA не используется — набор токенов для дальнейшей работы пользователя.
Если MFA используется — сообщение о необходимости войти в Панель управления Клиента для получения набора токенов (см. Вход).

PATCH {reseller_domain}/internal_api/reset_password

В этой статье:

Авторизация

Авторизация не требуется.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
reseller_domain	path	string	Обязательный	Доменное имя реселлера
email	form	string	Обязательный	Email пользователя, который используется как логин для входа в Панель управления Клиента
password	form	string	Обязательный	Новый пароль пользователя для входа в Панель управления Клиента. Требования к паролю см. в
reset_password_token	form	string	Обязательный	Токен для сброса пароля, который платформа отправила на email пользователя в результате вызова метода Запрос на сброс пароля и успешно провалидировала его в результате вызова метода Валидация токена для сброса пароля

Модель ответа

Метод возвращает набор токенов пользователя или сообщение о необходимости войти в Панель управления Клиента для получения набора токенов аналогично методу Подтверждение email.

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

Bash

curl --location --request PATCH 'https://test.activeplatform.com/internal_api/reset_password' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--data-raw '{
    "data": {
        "attributes": {
            "email": "user@example.com",
            "password": "12345678",
            "reset_password_token": "resetPasswordTokenExample"
        }
    }
}'

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

MFA не используется

JSON

Cookie: jwt_refresh=refreshTokenExample

{
    "access": "accessTokenExample",
    "csrf": "csrfTokenExample==",
    "refresh_expires_at": "2023-01-01T12:34:56.000+00:00"
}

MFA используется

JSON

{
    "status": "login_required"
}