セカンダリアプリケーション内で実行される基本認証フロー basic-authentication-flow-performed-within-secondary-application
Adobe Pass認証権限内の 認証フロー により、ストリーミングアプリケーションは、ユーザーが有効なMVPD アカウントを持っていることを確認できます。 このプロセスでは、ユーザーがアクティブなMVPD アカウントを持ち、MVPD ログインページに有効なログイン資格情報を入力する必要があります。
認証フローは、次の場合に必要です。
- ユーザーが初めてアプリケーションを開いたとき。
- ユーザーの以前の認証が期限切れになった場合。
- ユーザーがMVPD アカウントからログアウトすると。
- 別のMVPDで認証する場合。
これらすべての場合において、任意のプロファイルエンドポイントを呼び出すアプリケーションは、空の応答または1つ以上のプロファイルを受信しますが、異なるMVPDに対して受信します。
認証フローでは、ユーザーエージェント （ブラウザー）がアプリケーションからAdobe Pass バックエンド、次にMVPD ログインページ、最後にアプリケーションに戻る一連の呼び出しを完了する必要があります。 このフローには、MVPDシステムへの複数のリダイレクトや、各ドメインに保存されたCookieまたはセッションの管理が含まれる場合があります。これらは、ユーザーエージェントなしでは達成や保護が困難な場合があります。
MVPDを選択し、ユーザーエージェントで選択したMVPDを使用して認証するためのユーザーインタラクションをサポートするプライマリアプリケーション（ストリーミングアプリケーション）機能に基づいて、認証シナリオは次のとおりです。
事前に選択したmvpdを使用して、セカンダリアプリケーション内で認証を実行します perform-authentication-within-secondary-application-with-preselected-mvpd
前提条件 prerequisites-perform-authentication-within-secondary-application-with-preselected-mvpd
プライマリアプリケーション内で認証フローを開始し、セカンダリアプリケーション内でユーザーインタラクションを通じて認証フローを終了する前に、次の前提条件が満たされていることを確認します。
- ストリーミングアプリケーションでMVPDを選択する必要があります。
- 選択したMVPDでログインするには、ストリーミングアプリケーションで認証セッションを開始する必要があります。
- セカンダリアプリケーションは、ユーザーエージェントで選択したMVPDで認証する必要があります。
- ストリーミングアプリケーションは、MVPDを選択するためのユーザーインタラクションをサポートしています。
- セカンダリアプリケーション（通常はセカンダリデバイス）は、ユーザーエージェントで選択したMVPDを使用して認証するためのユーザーインタラクションをサポートします。
ワークフロー workflow-perform-authentication-within-secondary-application-with-preselected-mvpd
次の図に示すように、事前選択されたMVPDを使用してセカンダリアプリケーション内で実行される基本認証フローを実装するには、次の手順に従います。
事前に選択したmvpdを使用して、セカンダリアプリケーション内で認証を実行します
-
認証セッションの作成： ストリーミングアプリケーションは、Sessions エンドポイントを呼び出して、認証セッションを開始するために必要なすべてのデータを収集します。
note important IMPORTANT 詳細については、認証セッションの作成 API ドキュメントを参照してください。 serviceProvider、mvpd、domainName、redirectUrlなど、必須のすべてのパラメーターAuthorization、AP-Device-Identifierなど、必須 ヘッダーすべて- すべての_optional_ パラメーターとヘッダー
ストリーミングアプリケーションは、認証セッションの作成時に、1回の呼び出しで必要なすべてのパラメーターを提供する必要があります。 -
次のアクションを示します： セッションエンドポイントの応答には、次のアクションに関するストリーミングアプリケーションを導くために必要なデータが含まれています。
note important IMPORTANT セッション応答で提供される情報について詳しくは、認証セッションの作成 API ドキュメントを参照してください。 セッションエンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。 - 必須 パラメーターとヘッダーは有効である必要があります。
- 指定された
serviceProviderとmvpdの統合はアクティブである必要があります。
検証が失敗すると、エラー応答が生成され、拡張エラーコード のドキュメントに準拠する追加情報が提供されます。 -
決定フローで続行： セッションエンドポイントの応答には、次のデータが含まれます。
actionName属性が「authorize」に設定されています。actionType属性が「direct」に設定されています。
Adobe Pass バックエンドが有効なプロファイルを識別する場合、後続の意思決定フローに使用できるプロファイルが既に存在するため、ストリーミングアプリケーションは選択したMVPDで再認証する必要がありません。
-
認証コードを表示： セッション エンドポイントの応答には、次のデータが含まれています。
- セカンダリ アプリケーション内で認証セッションを再開するために使用できる
code。 actionName属性が「authenticate」に設定されています。actionType属性が「インタラクティブ」に設定されています。
Adobe Pass バックエンドが有効なプロファイルを識別しない場合、ストリーミングアプリケーションには、セカンダリアプリケーション内で認証セッションを再開するために使用できる
codeが表示されます。 - セカンダリ アプリケーション内で認証セッションを再開するために使用できる
-
認証コードの検証： セカンダリ アプリケーションは、指定された
codeのユーザーを検証し、ユーザーエージェントでMVPD認証を続行できるようにします。note important IMPORTANT 詳細については、認証セッション情報の取得 API ドキュメントを参照してください。 serviceProviderやcodeなど、必須のすべてのパラメーターAuthorizationなど、すべての_必須_ ヘッダー- すべての_optional_ パラメーターとヘッダー
-
認証セッションに関する情報を返します。 セッションエンドポイントの応答には、次のデータが含まれます。
existing属性には、既に指定されている既存のパラメーターが含まれています。missing属性には、認証フローを完了するために指定する必要があるパラメーターが含まれています。
note important IMPORTANT セッション検証応答で提供される情報の詳細については、認証セッション情報の取得 API ドキュメントを参照してください。 セッションエンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。 - 必須 パラメーターとヘッダーは有効である必要があります。
検証が失敗すると、エラー応答が生成され、拡張エラーコード のドキュメントに準拠する追加情報が提供されます。 note tip TIP セカンダリ アプリケーションは、認証セッションが欠落していることを示すエラー応答が発生した場合に、使用されている codeが無効であることをユーザーに通知し、新しい認証セッションを使用して再試行するようにユーザーに通知できます。 -
ユーザーエージェントでURLを開く： セカンダリアプリケーションは、自己計算
urlを読み込むためにユーザーエージェントを開き、認証エンドポイントにリクエストを行います。 このフローには複数のリダイレクトが含まれる場合があり、最終的にはユーザーがMVPD ログインページに移動し、有効な資格情報を提供します。note important IMPORTANT 詳細については、 ユーザーエージェント APIでの認証の実行に関するドキュメントを参照してください。 serviceProviderやcodeなど、必須のすべてのパラメーター- すべての_optional_ パラメーターとヘッダー
-
MVPD認証を完了：認証フローが成功した場合、ユーザーエージェントのインタラクションはAdobe Pass バックエンドに通常のプロファイルを保存し、指定された
redirectUrlに到達します。 -
特定のコードのプロファイルの取得： ストリーミングアプリケーションは、プロファイルエンドポイントにリクエストを送信することで、プロファイル情報を取得するために必要なすべてのデータを収集します。
note important IMPORTANT 次の詳細については、特定のコードの プロファイルの取得 API ドキュメントを参照してください。 serviceProviderやcodeなど、必須のすべてのパラメーターAuthorization、AP-Device-Identifierなど、必須 ヘッダーすべて- すべての_optional_ パラメーターとヘッダー
note tip TIP ストリーミングアプリケーションは、 codeを使用してポーリングメカニズムを実装し、通常のプロファイルが正常に生成され、保存されたかどうかを確認する必要があります。 -
通常のプロファイルに関する情報を返します： プロファイル エンドポイントの応答には、受信したパラメーターとヘッダーに関連付けられた通常のプロファイルに関する情報が含まれます。
note important IMPORTANT プロファイル応答で提供される情報の詳細については、特定のコードのプロファイルの取得 API ドキュメントを参照してください。 プロファイルエンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。 - 必須 パラメーターとヘッダーは有効である必要があります。
検証が失敗すると、エラー応答が生成され、拡張エラーコード のドキュメントに準拠する追加情報が提供されます。
事前に選択したmvpdを使用せずに、セカンダリアプリケーション内で認証を実行します perform-authentication-within-secondary-application-without-preselected-mvpd
前提条件 prerequisites-perform-authentication-within-secondary-application-without-preselected-mvpd
プライマリアプリケーション内で認証フローを開始し、セカンダリアプリケーション内でユーザーインタラクションを通じて認証フローを終了する前に、次の前提条件が満たされていることを確認します。
- ストリーミングアプリケーションは、ログインが必要なときに認証セッションを開始する必要があります。
- セカンダリアプリケーションでMVPDを選択する必要があります。
- セカンダリアプリケーションは、ユーザーエージェントで選択したMVPDで認証する必要があります。
- セカンダリアプリケーション（通常はセカンダリデバイス）は、MVPDを選択するためのユーザーインタラクションをサポートしています。
- セカンダリアプリケーション（通常はセカンダリデバイス）は、ユーザーエージェントで選択したMVPDを使用して認証するためのユーザーインタラクションをサポートします。
ワークフロー workflow-perform-authentication-within-secondary-application-without-preselected-mvpd
次の図に示すように、事前選択されたMVPDを使用せずにセカンダリアプリケーション内で実行される基本認証フローを実装するには、次の手順に従います。
事前に選択したmvpdを使用せずに、セカンダリアプリケーション内で認証を実行する
-
認証セッションの作成： ストリーミング アプリケーションは、セッション エンドポイントを呼び出して、認証セッションを開始するために必要なデータの一部を収集します。
note important IMPORTANT 詳細については、認証セッションの作成 API ドキュメントを参照してください。 serviceProviderなど、すべての_必須_ パラメーターAuthorization、AP-Device-Identifierなど、必須 ヘッダーすべて- すべての_optional_ パラメーターとヘッダー
ストリーミングアプリケーションは、認証セッションの作成時に、1回の呼び出しで必要なすべてのパラメーターを提供することはできません。 -
次のアクションを示します。 セッション エンドポイントの応答には、次のアクションに関するストリーミング アプリケーションをガイドするために必要なデータが含まれています。
- セカンダリ アプリケーション内で認証セッションを再開するために使用できる
code。 actionName属性が「resume」に設定されています。actionType属性が「direct」に設定されています。
note important IMPORTANT セッション応答で提供される情報について詳しくは、認証セッションの作成 API ドキュメントを参照してください。 セッションエンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。 - 必須 パラメーターとヘッダーは有効である必要があります。
検証が失敗すると、エラー応答が生成され、拡張エラーコード のドキュメントに準拠する追加情報が提供されます。 - セカンダリ アプリケーション内で認証セッションを再開するために使用できる
-
認証コードを表示： ストリーミング アプリケーションには、セカンダリ アプリケーション内で認証セッションを再開するために使用できる
codeが表示されます。 -
認証セッションに不足しているパラメーターを指定： セカンダリ アプリケーションは、認証セッションを再開するために必要なすべての不足しているデータを収集し、セッション エンドポイントを呼び出します。
note important IMPORTANT 次の詳細については、認証セッションの再開 API ドキュメントを参照してください。 serviceProvider、mvpd、domainName、redirectUrlなど、必須のすべてのパラメーターAuthorization、AP-Device-Identifierなど、必須 ヘッダーすべて- すべての_optional_ パラメーターとヘッダー
-
次のアクションを示します： セッションエンドポイントの応答には、次のアクションに関するストリーミングアプリケーションを導くために必要なデータが含まれています。
note important IMPORTANT セッション応答で提供される情報について詳しくは、認証セッションの再開 API ドキュメントを参照してください。 セッションエンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。 - 必須 パラメーターとヘッダーは有効である必要があります。
- 指定された
serviceProviderとmvpdの統合はアクティブである必要があります。
検証が失敗すると、エラー応答が生成され、拡張エラーコード のドキュメントに準拠する追加情報が提供されます。 note tip TIP セカンダリ アプリケーションは、認証セッションが欠落していることを示すエラー応答が発生した場合に、使用されている codeが無効であることをユーザーに通知し、新しい認証セッションを使用して再試行するようにユーザーに通知できます。 -
既存のプロファイルを示します： セッションエンドポイントの応答には、次のデータが含まれます。
actionName属性が「authorize」に設定されています。actionType属性が「direct」に設定されています。
Adobe Pass バックエンドが有効なプロファイルを識別する場合、後続の意思決定フローに使用できるプロファイルが既に存在するため、ストリーミングアプリケーションは選択したMVPDで再認証する必要がありません。
-
ユーザーエージェントでURLを開く： セッションエンドポイントの応答には、次のデータが含まれます。
- MVPD ログインページ内でインタラクティブ認証を開始するために使用できる
url。 actionName属性が「authenticate」に設定されています。actionType属性が「インタラクティブ」に設定されています。
Adobe Pass バックエンドが有効なプロファイルを識別しない場合、セカンダリアプリケーションはユーザーエージェントを開いて、指定された
urlを読み込み、認証エンドポイントにリクエストを行います。 このフローには複数のリダイレクトが含まれる場合があり、最終的にはユーザーがMVPD ログインページに移動し、有効な資格情報を提供します。 - MVPD ログインページ内でインタラクティブ認証を開始するために使用できる
-
MVPD認証を完了：認証フローが成功した場合、ユーザーエージェントのインタラクションはAdobe Pass バックエンドに通常のプロファイルを保存し、指定された
redirectUrlに到達します。 -
特定のコードのプロファイルの取得： ストリーミングアプリケーションは、プロファイルエンドポイントにリクエストを送信することで、プロファイル情報を取得するために必要なすべてのデータを収集します。
note important IMPORTANT 次の詳細については、特定のコードの プロファイルの取得 API ドキュメントを参照してください。 serviceProviderやcodeなど、必須のすべてのパラメーターAuthorization、AP-Device-Identifierなど、必須 ヘッダーすべて- すべての_optional_ パラメーターとヘッダー
note tip TIP ストリーミングアプリケーションは、 codeを使用してポーリングメカニズムを実装し、通常のプロファイルが正常に生成され、保存されたかどうかを確認する必要があります。 -
通常のプロファイルに関する情報を返します： プロファイル エンドポイントの応答には、受信したパラメーターとヘッダーに関連付けられた通常のプロファイルに関する情報が含まれます。
note important IMPORTANT プロファイル応答で提供される情報の詳細については、特定のコードのプロファイルの取得 API ドキュメントを参照してください。 プロファイルエンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。 - 必須 パラメーターとヘッダーは有効である必要があります。
検証が失敗すると、エラー応答が生成され、拡張エラーコード のドキュメントに準拠する追加情報が提供されます。