Авторизация аккаунта

Состояние аутентификации

Возвращает текущее состояние потока аутентификации: следующий шаг (code, QR, Passkey, пароль, импорт сессии) либо «уже аутентифицирован». Для Passkey возможны passkey_required, passkey_pending, passkey_confirmation и passkey_confirmation_sent; auth_payload.public_key содержит challenge WebAuthn, а auth_payload также может содержать подсказку подтверждения. expires_at указывает, когда payload становится недействительным.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/auth

Перед вызовом

Используйте X-Api-Key нужного рабочего пространства на сервере. Перед запуском замените все заполнители.

Откуда взять параметры

account_id: Возьмите data.id из создания или запроса аккаунта. Идентификатор относится к рабочему пространству X-Api-Key. Получить аккаунт

Параметры запроса

Заголовки

X-Api-Key

stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Параметры пути

account_id

stringобязательно

Идентификатор для маршрута раздела authentication.

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

Как понять результат

Следуйте описанию полей и HTTP-статуса. Успешный 204 не содержит тела; для диагностики используйте X-Request-Id. Следующий шаг указан в связанных операциях.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "account_id": "acc_example",
    "status": "awaiting_qr_scan",
    "auth_fields": [
      {
        "type": "qr_code",
        "required": true
      }
    ],
    "auth_payload": {
      "qr_code": "https://example.com/qr"
    },
    "expires_at": "2026-01-01T00:00:00Z",
    "last_error": ""
  }
}

Тело ответа

account_id

string

Аккаунт провайдера, к которому относится этот ответ.

status

string

Текущий статус потока авторизации, например pending_auth, awaiting_qr_scan, awaiting_code, pending, passkey_required, passkey_pending, passkey_confirmation, passkey_confirmation_sent, authorized или failed.

auth_fields[]

object[]

Описывает, что требуется на следующем шаге — каждый элемент содержит type и признак обязательности.

type

string

Тип ввода для следующего шага аутентификации, например code или password.

required

boolean

Обязательно ли предоставить это значение аутентификации.

label

string

Отображаемая подпись поля от provider, если доступна.

placeholder

string

Подсказка поля ввода от provider, если доступна.

auth_payload

object

Стандартная полезная нагрузка для текущего шага. QR использует qr_code; шаг проверки кода использует type=code; Passkey использует type=passkey и public_key. Полезные нагрузки взаимоисключающих шагов не появляются вместе.

expires_at

string

Метка времени RFC3339, после которой текущий auth_payload становится недействительным.

format: date-time

last_error

string

Последняя ошибка аутентификации или пустая строка, если её нет.

Ответы

200

200 OK

Запрос выполнен. См. пример тела ответа.

401

Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

500

Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

При ошибке запроса

Проверьте HTTP и error.code/numeric_code, сохраните request_id. Исправьте параметры, завершите авторизацию или проверьте runtime. До повторной отправки или записи выясните результат предыдущей попытки. Справочник ошибок

invalid_request · 10000 · 400: Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
invalid_api_key · 11001 · 401: Проверьте X-Api-Key и активность рабочего пространства.