ドキュメントAdobe PassAdobe Pass 認証

セカンダリ・アプリケーション内で実行される基本認証フロー basic-authentication-flow-performed-within-secondary-application

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
このページのコンテンツは情報提供のみを目的としています。 この API を使用するには、Adobeの最新ライセンスが必要です。 無許可の使用は許可されていません。
IMPORTANT
REST API V2 の実装については、 スロットルメカニズムのドキュメントで制限されています。
Related Articles
また、REST API V2 の FAQ も必ず参照してください。

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で認証する必要があります。
IMPORTANT
前提
  • ストリーミングアプリケーションは、MVPDを選択するためのユーザーインタラクションをサポートしています。
  • セカンダリアプリケーション（通常はセカンダリデバイス上）は、ユーザーエージェント内の選択されたMVPDによる認証を行うユーザーインタラクションをサポートします。

ワークフロー workflow-perform-authentication-within-secondary-application-with-preselected-mvpd

次の図に示すように、事前に選択されたMVPDを使用して、セカンダリアプリケーション内で実行される基本認証フローを実装するには、次の手順に従います。

事前に選択された mvpd を使用して、セカンダリ・アプリケーション内で認証を実行する

事前に選択された mvpd を使用して、セカンダリ・アプリケーション内で認証を実行する

  1. 認証セッションの作成： ストリーミングアプリケーションは、セッションエンドポイントを呼び出して認証セッションを開始するために必要なすべてのデータを収集します。

    note important
    IMPORTANT
    次について詳しくは、 認証セッションの作成API ドキュメントを参照してください。
    • serviceProvider、mvpd、domainName、redirectUrl などのすべての 必須 パラメーター
    • Authorization、AP-Device-Identifier などのすべての 必須 ヘッダー
    • すべての オプション パラメーターおよびヘッダー
    ストリーミングアプリケーションは、認証セッションを作成する際に、1 回の呼び出しで必要なすべてのパラメーターを指定する必要があります。

  2. 次のアクションを示す： セッションエンドポイント応答には、次のアクションに関するストリーミングアプリケーションのガイドに必要なデータが含まれています。

    note important
    IMPORTANT
    セッション応答で提供される情報について詳しくは、 認証セッションの作成API ドキュメントを参照してください。
    セッション エンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。
    • required パラメーターおよびヘッダーは有効である必要があります。
    • 指定した serviceProvider と mvpd の統合はアクティブである必要があります。
    検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。

  3. 決定フローで続行： セッションエンドポイント応答には、次のデータが含まれます。

    • actionName 属性は「authorize」に設定されます。
    • actionType 属性は「direct」に設定されます。

    Adobe Pass バックエンドが有効なプロファイルを特定した場合、その後の決定フローに使用できるプロファイルが既に存在するので、ストリーミングアプリケーションは選択したMVPDで再認証する必要はありません。

  4. 認証コードを表示： セッションエンドポイント応答には、次のデータが含まれます。

    • セカンダリ・アプリケーション内で認証セッションを再開するために使用できる code。
    • actionName 属性は「authenticate」に設定されています。
    • actionType 属性は「interactive」に設定されます。

    Adobe Pass バックエンドが有効なプロファイルを識別できない場合、ストリーミングアプリケーションは、セカンダリアプリケーション内で認証セッションを再開するために使用できる code を表示します。

  5. 認証コードを検証： セカンダリアプリケーションは、提供されたユーザーを検証 code、User Agent のMVPD認証で続行できることを確認します。

    note important
    IMPORTANT
    次について詳しくは、 認証セッション情報の取得API ドキュメントを参照してください。
    • serviceProvider や code など、すべての 必須 パラメーター
    • Authorization のようなすべての 必須 ヘッダー
    • すべての オプション パラメーターおよびヘッダー

  6. 認証セッションに関する情報を返す： セッションエンドポイント応答には、次のデータが含まれています。

    • existing 属性には、既に指定されている既存のパラメーターが含まれます。
    • missing 属性には、認証フローを完了するために指定する必要がある、欠落しているパラメーターが含まれています。
    note important
    IMPORTANT
    セッション検証応答で提供される情報について詳しくは、 認証セッション情報の取得API ドキュメントを参照してください。
    セッション エンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。
    • required パラメーターおよびヘッダーは有効である必要があります。
    検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。
    note tip
    TIP
    提案：セカンダリ・アプリケーションは、認証セッションが欠落していることを示すエラー応答が発生した場合に使用された code が無効であることをユーザーに通知し、新しいセッションを使用して再試行するようにユーザーに通知できます。

  7. ユーザーエージェントで URL を開く： セカンダリアプリケーションがユーザーエージェントを開いて、自己計算された url を読み込み、認証エンドポイントにリクエストを送信します。 このフローには、複数のリダイレクトが含まれる場合があり、最終的にユーザーがMVPDのログインページに移動して、有効な資格情報を提供します。

    note important
    IMPORTANT
    次について詳しくは、 ユーザーエージェントでの認証の実行API ドキュメントを参照してください。
    • serviceProvider や code など、すべての 必須 パラメーター
    • すべての オプション パラメーターおよびヘッダー

  8. MVPD認証の完了： 認証フローが正常に完了すると、ユーザーエージェントインタラクションは通常のプロファイルをAdobe Pass バックエンドに保存し、指定された redirectUrl に到達します。

  9. 特定のコードのプロファイルを取得： ストリーミングアプリケーションは、プロファイルエンドポイントにリクエストを送信することで、プロファイル情報を取得するために必要なすべてのデータを収集します。

    note important
    IMPORTANT
    次について詳しくは、 特定のコードのプロファイルの取得API ドキュメントを参照してください。
    • serviceProvider や code など、すべての 必須 パラメーター
    • Authorization、AP-Device-Identifier などのすべての 必須 ヘッダー
    • すべての オプション パラメーターおよびヘッダー
    note tip
    TIP
    提案：ストリーミングアプリケーションでは、code を使用してポーリングメカニズムを実装し、通常のプロファイルが正常に生成および保存されたかどうかを確認できます。

  10. 通常のプロファイルに関する情報を返す： プロファイルエンドポイント応答には、受信したパラメーターとヘッダーに関連付けられた通常のプロファイルに関する情報が含まれます。

    note important
    IMPORTANT
    プロファイル応答で提供される情報について詳しくは、 特定のコードのプロファイルの取得API ドキュメントを参照してください。
    プロファイルエンドポイントは、基本条件が満たされていることを確認するために、リクエストデータを検証します。
    • required パラメーターおよびヘッダーは有効である必要があります。
    検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。

事前に選択された mvpd を使用せずに、セカンダリ・アプリケーション内で認証を実行 perform-authentication-within-secondary-application-without-preselected-mvpd

前提条件 prerequisites-perform-authentication-within-secondary-application-without-preselected-mvpd

プライマリアプリケーション内で認証フローを開始し、セカンダリアプリケーション内のユーザーインタラクションを通じて認証フローを終了する前に、次の前提条件が満たされていることを確認します。

  • ストリーミングアプリケーションは、ログインする必要がある場合に認証セッションを開始する必要があります。
  • セカンダリアプリケーションはMVPDを選択する必要があります。
  • セカンダリアプリケーションは、ユーザーエージェント内の選択されたMVPDで認証する必要があります。
IMPORTANT
前提
  • セカンダリアプリケーション（通常はセカンダリデバイス上）は、MVPDを選択するためのユーザーインタラクションをサポートします。
  • セカンダリアプリケーション（通常はセカンダリデバイス上）は、ユーザーエージェント内の選択されたMVPDによる認証を行うユーザーインタラクションをサポートします。

ワークフロー workflow-perform-authentication-within-secondary-application-without-preselected-mvpd

次の図に示すように、事前に選択されたMVPDを使用せずに、セカンダリアプリケーション内で実行される基本認証フローを実装するには、次の手順に従います。

事前に選択された mvpd を使用せずに、セカンダリ・アプリケーション内で認証を実行

事前に選択された mvpd を使用せずに、セカンダリ・アプリケーション内で認証を実行

  1. 認証セッションの作成： ストリーミングアプリケーションは、セッションエンドポイントを呼び出して認証セッションを開始するために必要なデータの一部を収集します。

    note important
    IMPORTANT
    次について詳しくは、 認証セッションの作成API ドキュメントを参照してください。
    • serviceProvider のようなすべての 必須 パラメーター
    • Authorization、AP-Device-Identifier などのすべての 必須 ヘッダー
    • すべての オプション パラメーターおよびヘッダー
    認証セッションの作成時、ストリーミングアプリケーションは 1 回の呼び出しで必要なすべてのパラメーターを提供することはできません。

  2. 次のアクションを示す： セッションエンドポイント応答には、次のアクションに関するストリーミングアプリケーションのガイドとして必要なデータが含まれます。

    • セカンダリ・アプリケーション内で認証セッションを再開するために使用できる code。
    • actionName 属性は「resume」に設定されます。
    • actionType 属性は「direct」に設定されます。
    note important
    IMPORTANT
    セッション応答で提供される情報について詳しくは、 認証セッションの作成API ドキュメントを参照してください。
    セッション エンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。
    • required パラメーターおよびヘッダーは有効である必要があります。
    検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。

  3. 認証コードを表示： ストリーミングアプリケーションは、セカンダリアプリケーション内で認証セッションを再開するために使用できる code ードを表示します。

  4. 認証セッションの不足しているパラメーターを指定する： セカンダリ アプリケーションは、認証セッションの再開に必要なすべての不足しているデータを収集し、セッション エンドポイントを呼び出します。

    note important
    IMPORTANT
    次の項目について詳しくは、 認証セッションの再開API ドキュメントを参照してください。
    • serviceProvider、mvpd、domainName、redirectUrl などのすべての 必須 パラメーター
    • Authorization、AP-Device-Identifier などのすべての 必須 ヘッダー
    • すべての オプション パラメーターおよびヘッダー

  5. 次のアクションを示す： セッションエンドポイント応答には、次のアクションに関するストリーミングアプリケーションのガイドに必要なデータが含まれています。

    note important
    IMPORTANT
    セッション応答で提供される情報について詳しくは、 認証セッションの再開API ドキュメントを参照してください。
    セッション エンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。
    • required パラメーターおよびヘッダーは有効である必要があります。
    • 指定した serviceProvider と mvpd の統合はアクティブである必要があります。
    検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。
    note tip
    TIP
    提案：セカンダリ・アプリケーションは、認証セッションが欠落していることを示すエラー応答が発生した場合に使用された code が無効であることをユーザーに通知し、新しいセッションを使用して再試行するようにユーザーに通知できます。

  6. 既存のプロファイルを示す： セッションエンドポイントの応答には、次のデータが含まれます。

    • actionName 属性は「authorize」に設定されます。
    • actionType 属性は「direct」に設定されます。

    Adobe Pass バックエンドが有効なプロファイルを特定した場合、その後の決定フローに使用できるプロファイルが既に存在するので、ストリーミングアプリケーションは選択したMVPDで再認証する必要はありません。

  7. ユーザーエージェントで URL を開く： セッションエンドポイントの応答には、次のデータが含まれます。

    • MVPDのログインページ内でインタラクティブ認証を開始するために使用できる url。
    • actionName 属性は「authenticate」に設定されています。
    • actionType 属性は「interactive」に設定されます。

    Adobe Pass バックエンドが有効なプロファイルを識別できない場合、セカンダリアプリケーションは User Agent を開いて指定されたプロファイ url を読み込み、Authenticate エンドポイントにリクエストを行います。 このフローには、複数のリダイレクトが含まれる場合があり、最終的にユーザーがMVPDのログインページに移動して、有効な資格情報を提供します。

  8. MVPD認証の完了： 認証フローが正常に完了すると、ユーザーエージェントインタラクションは通常のプロファイルをAdobe Pass バックエンドに保存し、指定された redirectUrl に到達します。

  9. 特定のコードのプロファイルを取得： ストリーミングアプリケーションは、プロファイルエンドポイントにリクエストを送信することで、プロファイル情報を取得するために必要なすべてのデータを収集します。

    note important
    IMPORTANT
    次について詳しくは、 特定のコードのプロファイルの取得API ドキュメントを参照してください。
    • serviceProvider や code など、すべての 必須 パラメーター
    • Authorization、AP-Device-Identifier などのすべての 必須 ヘッダー
    • すべての オプション パラメーターおよびヘッダー
    note tip
    TIP
    提案：ストリーミングアプリケーションでは、code を使用してポーリングメカニズムを実装し、通常のプロファイルが正常に生成および保存されたかどうかを確認できます。

  10. 通常のプロファイルに関する情報を返す： プロファイルエンドポイント応答には、受信したパラメーターとヘッダーに関連付けられた通常のプロファイルに関する情報が含まれます。

    note important
    IMPORTANT
    プロファイル応答で提供される情報について詳しくは、 特定のコードのプロファイルの取得API ドキュメントを参照してください。
    プロファイルエンドポイントは、基本条件が満たされていることを確認するために、リクエストデータを検証します。
    • required パラメーターおよびヘッダーは有効である必要があります。
    検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b