パートナーフローを使用したシングルサインオン single-sign-on-partner-flows
パートナーメソッドを使用すると、複数のアプリケーションでパートナーフレームワークステータスペイロードを使用して、Adobe Pass サービスの使用時にデバイスレベルでシングルサインオン（SSO）を実現できます。
Adobe Pass システム外のパートナー固有のフレームワークやライブラリを使用して、パートナーフレームワークステータスペイロードを取得する役割を持ちます。
アプリケーションは、このパートナーフレームワークステータスペイロードを指定するすべてのリクエストの AP-Partner-Framework-Status ヘッダーの一部として含める責任があります。
ヘッダーについて詳 AP-Partner-Framework-Status くは、AP-Partner-Framework-Status ドキュメントを参照してください。
Adobe Pass認証 REST API V2 は、iOS、iPadOS、tvOS で動作するクライアントアプリケーションのエンドユーザー向けに、パートナーシングルサインオン（SSO）をサポートしています。
Apple プラットフォームのシングルサインオン （SSO）について詳しくは、Apple SSO クックブック （REST API V2）ドキュメントを参照してください。
パートナー認証要求の取得 retrieve-partner-authentication-request
前提条件 prerequisites-retrieve-partner-authentication-request
パートナー認証リクエストを取得する前に、次の前提条件が満たされていることを確認します。
- パートナーフレームワークは MVPD を選択する必要があります。
- ストリーミングアプリケーションは、パートナーフレームワークからパートナーフレームワークのステータス情報を取得し、Adobe Pass サーバーに渡す必要があります。
- ストリーミングアプリケーションは、Adobe Pass サーバーからパートナー認証リクエストを取得し、パートナーフレームワークに渡す必要があります。
- パートナーフレームワークは、MVPD を選択するためのユーザーインタラクションをサポートします。
- パートナーフレームワークは、選択された MVPD で認証するためのユーザー操作をサポートします。
- パートナーフレームワークは、ユーザー権限およびプロバイダー情報を提供します。
ワークフロー workflow-retrieve-partner-authentication-request
以下の図に示すように、パートナー認証リクエストを取得するには、以下の手順を実行します。
パートナー認証要求の取得
-
パートナーフレームワークステータスの取得： ストリーミングアプリケーションは、Adobe Pass システムの外部でパートナーフレームワークを呼び出して、ユーザー権限とプロバイダー情報を取得します。
-
パートナーフレームワークのステータス情報を返す： ストリーミングアプリケーションは、基本条件が満たされていることを確認するために応答データを検証します。
- ユーザー権限のアクセスステータスが付与されます。
- ユーザープロバイダーマッピング識別子が存在し、有効です。
- ユーザープロバイダープロファイルの有効期限（使用可能な場合）は有効です。
-
パートナー認証リクエストの取得： ストリーミングアプリケーションは、セッションパートナーエンドポイントを呼び出して認証セッションを開始するために必要なすべてのデータを収集します。
note important IMPORTANT 次の項目について詳しくは、 パートナー認証リクエストの取得API ドキュメントを参照してください。 serviceProviderやpartnerなど、すべての 必須 パラメーターAuthorization、AP-Device-Identifier、Content-Type、X-Device-Info、AP-Partner-Framework-Statusなど、すべての 必須 ヘッダー- すべての オプション ヘッダーとパラメーター
ストリーミングアプリケーションは、リクエストを行う前に、パートナーフレームワークのステータスに有効な値が含まれていることを確認する必要があります。 ヘッダーについて詳 AP-Partner-Framework-Statusくは、AP-Partner-Framework-Status ドキュメントを参照してください。 -
次のアクションを示す： セッションパートナーエンドポイント応答には、次のアクションに関するストリーミングアプリケーションをガイドするために必要なデータが含まれています。
note important IMPORTANT セッション応答で提供される情報について詳しくは、 パートナー認証リクエストの取得API ドキュメントを参照してください。 セッションパートナーエンドポイントは、基本条件が満たされていることを確認するためにリクエストデータを検証します。 - required パラメーターおよびヘッダーは有効である必要があります。
- 指定した
serviceProviderとmvpdの統合はアクティブである必要があります。
基本検証が失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。 セッションパートナーエンドポイントは、リクエストデータを検証して、パートナーのシングルサインオン条件が満たされていることを確認します。 - Adobe Pass サーバーのパートナーのシングルサインオン設定が有効であり、有効である必要があります。
- AP-Partner-Framework-Status ヘッダーを介して受信したパートナーフレームワークステータスペイロードは、有効である必要があります。
パートナーのシングルサインオン検証が失敗した場合、応答はデフォルトで基本認証フローに設定されます。 -
パートナー認証応答を使用してプロファイル取得フローを続行： セッションパートナーエンドポイント応答には、次のデータが含まれています。
actionName属性は「partner_profile」に設定されます。actionType属性は「direct」に設定されます。authenticationRequest - type属性には、MVPD ログイン用のパートナーフレームワークによって使用されるセキュリティプロトコルが含まれます（現在は SAML のみに設定されています）。authenticationRequest - request属性には、パートナーフレームワークに渡される SAML リクエストが含まれます。authenticationRequest - attributesNames属性には、パートナーフレームワークに渡される SAML 属性が含まれます。
Adobe Pass バックエンドが有効なプロファイルを識別できず、パートナーのシングルサインオン検証に合格した場合、ストリーミングアプリケーションはアクションとデータを含む応答を受け取り、MVPD を使用した認証フローを開始するためにパートナーフレームワークに渡します。
パートナー認証応答を使用したプロファイル取得フローについて詳しくは、 パートナー認証応答を使用したプロファイルの取得を参照してください。
-
基本認証フローを続行： セッションパートナーエンドポイント応答には、次のデータが含まれています。
actionName属性は、「authenticate」または「resume」に設定されます。actionType属性は、「interactive」または「direct」に設定されます。
Adobe Pass バックエンドが有効なプロファイルを識別せず、パートナーのシングルサインオン検証に失敗した場合、Adobe Pass サーバーは基本認証フローにフォールバックします。
基本認証フローについて詳しくは、次のドキュメントを参照してください。
-
決定フローで続行： セッションパートナーエンドポイント応答には、次のデータが含まれます。
actionName属性は「authorize」に設定されます。actionType属性は「direct」に設定されます。
Adobe Pass バックエンドが有効なプロファイルを特定した場合、選択された MVPD でストリーミングアプリケーションを再認証する必要はありません。その後の決定フローで使用できるプロファイルが既に存在するからです。
note important IMPORTANT ストリーミングアプリケーションは、リクエストを行う前に、パートナーフレームワークのステータスに有効な値が含まれていることを確認する必要があります。 ヘッダーについて詳 AP-Partner-Framework-Statusくは、AP-Partner-Framework-Status ドキュメントを参照してください。
パートナー認証応答を使用したプロファイルの取得 retrieve-profile-using-partner-authentication-response
前提条件 prerequisites-retrieve-profile-using-partner-authentication-response
パートナー認証応答を使用してプロファイルを取得する前に、次の前提条件が満たされていることを確認します。
- パートナーフレームワークは、選択された MVPD で認証を実行する必要があります。
- ストリーミングアプリケーションは、パートナーフレームワークから、パートナーフレームワークステータス情報と共に、パートナー認証応答を取得して、Adobe Pass サーバーに渡す必要があります。
- パートナーフレームワークは、MVPD を選択するためのユーザーインタラクションをサポートします。
- パートナーフレームワークは、選択された MVPD で認証するためのユーザー操作をサポートします。
- パートナーフレームワークは、ユーザー権限およびプロバイダー情報を提供します。
ワークフロー workflow-retrieve-profile-using-partner-authentication-response
次の図に示すように、パートナー認証応答を使用してプロファイル取得フローを実装するには、指定の手順を実行します。
パートナー認証応答を使用して認証済みプロファイルを取得
-
パートナーフレームワークによる完全な MVPD 認証： 認証フローが成功すると、パートナーフレームワークと MVPD とのやり取りにより、パートナー認証応答（SAML 応答）が生成され、パートナーフレームワークのステータス情報と共に返されます。
-
パートナー認証応答を返す： ストリーミングアプリケーションは、基本条件が満たされていることを確認するために応答データを検証します。
- ユーザー権限のアクセスステータスが付与されます。
- ユーザープロバイダーマッピング識別子が存在し、有効です。
- ユーザープロバイダープロファイルの有効期限（使用可能な場合）は有効です。
-
パートナー認証応答を使用したプロファイルの取得： ストリーミングアプリケーションは、プロファイルパートナーエンドポイントを呼び出してプロファイルを作成および取得するために必要なすべてのデータを収集します。
note important IMPORTANT 次について詳しくは、 パートナー認証応答を使用したプロファイルの取得API ドキュメントを参照してください。 serviceProvider、partner、SAMLResponseなど、すべての 必須 パラメーターAuthorization、AP-Device-Identifier、Content-Type、X-Device-Info、AP-Partner-Framework-Statusなど、すべての 必須 ヘッダー- すべての オプション ヘッダーとパラメーター
ストリーミングアプリケーションは、リクエストを行う前に、パートナーフレームワークのステータスに有効な値が含まれていることを確認する必要があります。 ヘッダーについて詳 AP-Partner-Framework-Statusくは、AP-Partner-Framework-Status ドキュメントを参照してください。 -
パートナープロファイルの作成と保存： Adobe Pass サーバーは、すべての条件が満たされていることを確認した後、パートナープロファイルを作成して保存します。
-
パートナープロファイルに関する情報を返す： プロファイルエンドポイント応答には、「appleSSO」に設定されている属性
typeど、パートナープロファイルに関する情報が含まれています。note important IMPORTANT プロファイル応答で提供される情報について詳しくは、 パートナー認証応答を使用したプロファイルの取得API ドキュメントを参照してください。 プロファイルパートナーエンドポイントは、基本条件が満たされていることを確認するために、リクエストデータを検証します。 - required パラメーターおよびヘッダーは有効である必要があります。
- 指定した
serviceProviderとmvpdの統合はアクティブである必要があります。
検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。 プロファイルパートナーエンドポイントは、リクエストデータを検証して、パートナーのシングルサインオン条件が満たされていることを確認します。 - Adobe Pass サーバーのパートナーのシングルサインオン設定が有効であり、有効である必要があります。
- AP-Partner-Framework-Status ヘッダーを介して受信したパートナーフレームワークステータスペイロードは、有効である必要があります。
パートナーのシングルサインオン検証が失敗した場合、応答はデフォルトで基本プロファイル取得フローに設定されます。 -
決定フローで続行： ストリーミングアプリケーションは、後続の決定フローで続行できます。
note important IMPORTANT ストリーミングアプリケーションは、リクエストを行う前に、パートナーフレームワークのステータスに有効な値が含まれていることを確認する必要があります。 ヘッダーについて詳 AP-Partner-Framework-Statusくは、AP-Partner-Framework-Status ドキュメントを参照してください。