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