コードを使用した認証セッションの取得 retrieve-authentication-session-using-code

IMPORTANT
このページのコンテンツは情報提供のみを目的としています。 この API を使用するには、Adobeの最新ライセンスが必要です。 無許可の使用は許可されていません。
IMPORTANT
REST API V2 の実装については、​ スロットルメカニズム ​ のドキュメントで制限されています。

リクエスト request

HTTP
パス
/api/v2/{serviceProvider}/sessions/{code}
メソッド
GET
パスパラメーター
serviceProvider
オンボーディングプロセス中にサービスプロバイダーに関連付けられた内部の一意の ID。
必須
コード
ストリーミングデバイスで認証セッションを作成した後に取得した認証コード。
必須
ヘッダー
認証
ベアラートークンペイロードの生成については、Authorization ヘッダーのドキュメントを参照してください。
必須
X-Forwarded-For
ストリーミングデバイスの IP アドレス。

サーバーからサーバーへの実装には常に使用することを強くお勧めします。特に、呼び出しがストリーミングデバイスではなくプログラマーサービスによって行われる場合に強くお勧めします。

クライアントからサーバーへの実装の場合、ストリーミングデバイスの IP アドレスは暗黙的に送信されます。
optional
AP-Visitor-Identifier
訪問者識別子ペイロードの生成については、AP-Visitor-Identifier ヘッダードキュメントを参照してください。
optional
承諾
クライアントアプリケーションによって受け入れられるメディアタイプ。

指定する場合は、application/json;charset=utf-8 にする必要があります。
optional
User-Agent
クライアントアプリケーションのユーザーエージェント。
optional

応答 response

コード
テキスト
説明
200
OK
応答本文には、認証セッションに関する情報が含まれます。
400
リクエストが正しくありません
リクエストが無効です。クライアントはリクエストを修正して再試行する必要があります。 応答本文には、 拡張エラーコードドキュメントに従ったエラー情報が含まれている場合があります。
401
未認証
アクセストークンが無効です。クライアントは新しいアクセストークンを取得して、再試行する必要があります。 詳しくは、 動的クライアント登録の概要ドキュメントを参照してください。
405
許可されていないメソッド
HTTP メソッドが無効です。クライアントは、リクエストされたリソースに許可されている HTTP メソッドを使用し、再試行する必要があります。 詳しくは、 リクエストの節を参照してください。
500
内部サーバーエラー
サーバー側で問題が発生しました。 応答本文には、 拡張エラーコードドキュメントに従ったエラー情報が含まれている場合があります。

成功 success

ヘッダー
ステータス
200
必須
本文

次の属性を持つ JSON オブジェクト。

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff layout-auto html-authored
属性
existingParameters 既に指定されている既存のパラメーター。 必須
missingParameters 認証フローを完了するために指定する必要がある、不足しているパラメーター。 optional
デバイス 実際のストリーミングデバイスに関連するデバイス情報。 必須
notBefore 認証コードが無効になる前のタイムスタンプ(ミリ秒単位)。 必須
notAfter 認証コードが無効になるまでのタイムスタンプ(ミリ秒単位)。 必須
必須

エラー error

ヘッダー
ステータス
400、401、405、500
必須
Content-Type
application/json
必須
本文

応答本文には、 拡張エラーコードドキュメントに従った追加のエラー情報が提供される場合があります。

クライアントアプリケーションは、この API で最も一般的に返されるエラーコードを適切に処理できるエラー処理メカニズムを実装する必要があります。

  • invalid_authentication_session
  • invalid_parameter_code
  • 等。

上記のリストは完全ではありません。 クライアントアプリケーションは、 公開ドキュメントで定義されているすべての拡張エラーコードを処理できる必要があります。

必須

サンプル samples

​1. パラメーターなしで認証セッションを取得する

リクエスト
code language-https
GET /api/v2/sessions/REF30/8BLW4RW HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "existingParameters": {
        "mvpd": "apassidp",
        "domain": "adobe.com"
        "redirectUrl": "https://www.adobe.com",
        "serviceProvider": "REF30"
    },
    "device": {
        "type": "Desktop",
        "model": null,
        "version": {
            "major": 0,
            "minor": 0,
            "patch": 0,
            "profile": ""
        },
    "hardware": {
      "name": null,
      "vendor": "Apple",
      "version": {
        "major": 0,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "manufacturer": "Apple"
    },
    "operatingSystem": {
      "name": "macOS",
      "family": "macOS",
      "vendor": "Apple",
      "version": {
        "major": 10,
        "minor": 15,
        "patch": 7,
        "profile": ""
      }
    },
    "browser": {
      "name": "Chrome",
      "vendor": "Google",
      "version": {
        "major": 140,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36",
      "originalUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"
    },
    "display": {
      "width": 0,
      "height": 0,
      "ppi": 0,
      "name": "DISPLAY",
      "vendor": null,
      "version": null,
      "diagonalSize": null
    },
    "applicationId": null,
    "connection": {
      "ipAddress": "...",
      "port": "55161",
      "secure": false,
      "type": null
    }
    }
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

​1. パラメーターがない認証セッションを取得します

リクエスト
code language-https
GET /api/v2/sessions/REF30/8BLW4RW HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
  "missingParameters": [
    "mvpd"
  ],
  "existingParameters": {
    "redirectUrl": "https://adobe.com",
    "domainName": "adobe.com",
    "serviceProvider": "REF30"
  },
  "device": {
    "type": "Desktop",
    "model": null,
    "version": {
      "major": 0,
      "minor": 0,
      "patch": 0,
      "profile": ""
    },
    "hardware": {
      "name": null,
      "vendor": "Apple",
      "version": {
        "major": 0,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "manufacturer": "Apple"
    },
    "operatingSystem": {
      "name": "macOS",
      "family": "macOS",
      "vendor": "Apple",
      "version": {
        "major": 10,
        "minor": 15,
        "patch": 7,
        "profile": ""
      }
    },
    "browser": {
      "name": "Chrome",
      "vendor": "Google",
      "version": {
        "major": 140,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36",
      "originalUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"
    },
    "display": {
      "width": 0,
      "height": 0,
      "ppi": 0,
      "name": "DISPLAY",
      "vendor": null,
      "version": null,
      "diagonalSize": null
    },
    "applicationId": null,
    "connection": {
      "ipAddress": "...",
      "port": "3061",
      "secure": false,
      "type": null
    }
  },
  "notBefore": "1761299929958",
  "notAfter": "1761301729958"
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b