アカウント認可

認証ステータス取得

code、QR、パスワード、Passkey、セッションインポート、認証終端を含む現在の認証フロー状態を返します。Passkey 状態は passkey_required、passkey_pending、passkey_confirmation、passkey_confirmation_sent で、auth_payload に WebAuthn public_key が含まれる場合があります。

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

現在の auth_payload が無効になる時刻の RFC3339 タイムスタンプ。

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 を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。エラーリファレンス

invalid_request · 10000 · 400: 必須項目、形式、チャネルの条件を確認して修正します。
invalid_api_key · 11001 · 401: X-Api-Key とワークスペースの有効性を確認します。