Метод используется для подтверждения email, указанного при быстрой регистрации в Панели управления Клиента (см. Быстрая регистрация). В результате подтверждается email и метод возвращает следующую информацию:
-
Если MFA не используется — набор токенов для дальнейшей работы пользователя.
-
Если MFA используется — сообщение о необходимости войти в Панель управления Клиента для получения набора токенов (см. Вход).
PATCH {reseller_domain}/internal_api/confirmation_email
В этой статье:
Авторизация
Авторизация не требуется.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
confirmation_token |
form |
string |
Обязательный |
Токен для подтверждения email, указанного при быстрой регистрации в Панели управления Клиента. Он содержится в уведомлении, которой платформа отправляет на указанный email сразу после регистрации нового пользователя. Токен можно использовать только один раз, и у него есть период действия. См. также Повторное подтверждение email |
Модель ответа
MFA не используется
|
Название |
Тип данных |
Описание |
||||||
|---|---|---|---|---|---|---|---|---|
|
jwt_refresh |
cookie |
Refresh token пользователя |
||||||
|
access |
string |
Access token пользователя |
||||||
|
csrf |
string |
CSRF token пользователя |
||||||
|
refresh_expires_at |
string |
Дата истечения refresh token пользователя |
||||||
MFA используется
|
Название |
Тип данных |
Описание |
||||||
|---|---|---|---|---|---|---|---|---|
|
status |
string |
Имеет значение login_required — необходимо войти в Панель управления Клиента для получения набора токенов (см. Вход) |
||||||
Пример запроса
curl --location --request PATCH 'https://test.activeplatform.com/internal_api/confirmation_email' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--data-raw '{
"data": {
"attributes": {
"confirmation_token": "confirmationTokenExample"
}
}
}'
Пример ответа
MFA не используется
Cookie: jwt_refresh=refreshTokenExample
{
"access": "accessTokenExample",
"csrf": "csrfTokenExample==",
"refresh_expires_at": "2023-01-01T12:34:56.000+00:00"
}
MFA используется
{
"status": "login_required"
}