認証セッションの作成 create-authentication-session

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

リクエスト request

HTTP
パス
/api/v2/{serviceProvider}/sessions
メソッド
投稿する
パスパラメーター
serviceProvider
オンボーディングプロセス中にサービスプロバイダーに関連付けられた内部一意のID。
必須
Body パラメーター
mvpd
オンボーディングプロセス中にID プロバイダーに関連付けられた内部一意のID。

ストリーミングデバイスプラットフォームで値の提供に制限がある場合、アプリケーションは認証セッションを再開し、有効な値を提供する必要があります。
必須
domainName
MVPD ログインを実行するアプリケーションの元のドメイン。

ストリーミングデバイスプラットフォームで値の提供に制限がある場合、アプリケーションは認証セッションを再開し、有効な値を提供する必要があります。
必須
redirectUrl
MVPDの認証フローが完了したときにユーザーエージェントが移動する最後のリダイレクト URL。

値はURL エンコードする必要があります。

ストリーミングデバイスプラットフォームで値の提供に制限がある場合、アプリケーションは認証セッションを再開し、有効な値を提供する必要があります。
必須
ヘッダー
認証
ベアラートークンのペイロードの生成については、Authorization ヘッダーのドキュメントを参照してください。
必須
コンテンツタイプ
送信されるリソースの許可されたメディアタイプ。

application/x-www-form-urlencodedである必要があります。
必須
AP-Device-Identifier
デバイス識別子ペイロードの生成については、AP-Device-Identifier ヘッダーのドキュメントを参照してください。
必須
X-Device-Info
デバイス情報ペイロードの生成については、X-Device-Info ヘッダーのドキュメントを参照してください。

アプリケーションのデバイスプラットフォームで有効な値の明示的なプロビジョニングが可能な場合は、必ず使用することを強くお勧めします。

指定すると、Adobe Pass認証バックエンドは、明示的に設定された値と抽出された値を暗黙的に(デフォルトで)マージします。

指定しない場合、Adobe Pass認証バックエンドは、抽出された値を暗黙的に(デフォルトで)使用します。
必須
X-Forwarded-For
ストリーミングデバイスのIP アドレス。

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

クライアントからサーバーへの実装では、ストリーミングデバイスのIP アドレスが暗黙的に送信されます。
オプション
Adobe-Subject-Token
または
X-Roku-Reserved-Roku-Connect-Token
Platform ID メソッドのシングルサインオンペイロードの生成については、Adobe-Subject-Token / X-Roku-Reserved-Roku-Connect-Token ヘッダードキュメントを参照してください。

プラットフォーム IDを使用したシングルサインオン対応フローについて詳しくは、 プラットフォーム ID フローを使用したシングルサインオンのドキュメントを参照してください。
オプション
AD-Service-Token
サービストークン メソッドのシングルサインオンペイロードの生成については、AD-Service-Token ヘッダーのドキュメントを参照してください。

サービストークンを使用したシングルサインオン対応フローについて詳しくは、 サービストークンのフローを使用したシングルサインオンのドキュメントを参照してください。
オプション
AP-Visitor-Identifier
訪問者識別子ペイロードの生成については、AP-Visitor-Identifier ヘッダーのドキュメントを参照してください。
オプション
承認
クライアントアプリケーションが受け入れたメディアタイプ。

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

応答 response

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

成功 success

ヘッダー
ステータス
200
必須
コンテンツタイプ
アプリケーション/json
必須
本文

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

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-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 25-bgcolor-#deebff 29-bgcolor-#deebff 33-bgcolor-#deebff 37-bgcolor-#deebff 41-bgcolor-#deebff 45-bgcolor-#deebff layout-auto html-authored
属性
actionName

認証フローを完了するためにストリーミングデバイスが実行する必要があるアクション。

使用可能な値は次のとおりです。

  • 認証
    ストリーミングデバイスまたは別のデバイスは、ユーザーエージェントで指定されたURLを開く必要があります。
  • 再開
    ストリーミングデバイスまたは別のデバイスは、不足しているパラメーターを指定し、コードを使用して認証セッションを再開する必要があります。
  • authorize
    ストリーミングデバイスは、決定フローを直接進めることができます。
必須
actionType

「actionName」属性で指定されたアクションでフローを続行するために、ストリーミングデバイスが実行するインタラクションのタイプ。

使用可能な値は次のとおりです。

  • インタラクティブ
    ユーザーエージェントを使用して、指定されたURLへのナビゲーションを続行します。
  • direct
    フローは、クライアント実装で使用可能なHTTP クライアントを使用して、指定されたURLへの直接呼び出しを続けます。
必須
reasonType

「actionName」を説明する理由のタイプ。

使用可能な値は次のとおりです。

  • none
    認証を続行するには、クライアントアプリケーションが必要です。
  • 認証済み
    クライアントアプリケーションは、基本的なアクセスフローを通じて既に認証されています。
  • 一時
    クライアントアプリケーションは、一時アクセスフローを通じて既に認証されています。
  • 劣化
    クライアントアプリケーションは、劣化したアクセスフローを通じて既に認証されています。
  • authenticatedSSO
    クライアントアプリケーションは、既にシングルサインオンアクセスフローを通じて認証されています。
必須
missingParameters 基本認証フローを完了するために指定する必要があるパラメーターがありません。 オプション
url クライアントアプリケーションがナビゲートする必要があるURL。 オプション
コード 認証セッションを再開するためにセカンダリアプリケーションで使用できる認証コード。 オプション
sessionId ユーザー活動の追跡に使用できる不透明な識別子。 必須
mvpd オンボーディングプロセス中にID プロバイダーに関連付けられた内部一意のID。 オプション
serviceProvider オンボーディングプロセス中にサービスプロバイダーに関連付けられた内部一意のID。 必須
notBefore 認証コードが無効になるまでのタイムスタンプ(ミリ秒単位)。 オプション
notAfter 認証コードが無効になるまでのタイムスタンプ(ミリ秒単位)。 オプション
必須

エラー error

ヘッダー
ステータス
400, 401, 405, 500
必須
コンテンツタイプ
アプリケーション/json
必須
本文
応答本文は、拡張エラーコードドキュメントに準拠する追加のエラー情報を提供する場合があります。
必須

サンプル samples

​1. パラメーターを欠落せずに認証セッションを作成する

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

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
応答
code language-https
HTTP/1.1 200 OK

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

{
    "actionName": "authenticate",
    "actionType": "interactive",
    "reasonType": "none",
    "url": "/api/v2/authenticate/REF30/8ER640M",
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30",
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

​2. パラメーターが欠落している認証セッションの作成

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

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:
応答
code language-https
HTTP/1.1 200 OK

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

{
    "actionName": "resume",
    "actionType": "direct",
    "reasonType": "none",
    "url": "/api/v2/REF30/sessions/8ER640M",
    "missingParameters": ["mvpd", "domain", "redirectUrl"],
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "serviceProvider": "REF30",
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

​3. 有効なプロファイルが既に存在する間に認証セッションを作成する

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

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
応答
code language-https
HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "authenticated",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

​4. 基本またはプロモーション用のTempPassを使用して認証セッションを作成する(必須ではありません)

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

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=TempPass_TEST40&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
応答
code language-https
HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "temporary",
    "url": "/api/v2/REF30/decisions/authorize/TempPass_TEST40",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "TempPass_TEST40",
    "serviceProvider": "REF30"
}

​5. 劣化の適用中に認証セッションを作成する

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

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
応答
code language-https
HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "degraded",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}
recommendation-more-help
pass-help-authentication