ドキュメントAdobe PassAdobe Pass 認証

パートナー認証応答を使用したプロファイルの作成と取得 create-and-retrieve-profile-using-partner-authentication-response

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

リクエスト request

HTTP
パス
/api/v2/{serviceProvider}/profiles/sso/{partner}
メソッド
投稿する
パスパラメーター
serviceProvider
オンボーディングプロセス中にサービスプロバイダーに関連付けられた内部一意のID。
必須
パートナー
Adobe Pass認証フローと統合されたシングルサインオンフレームワークを提供するパートナー（Appleなど）の名前。
必須
Body パラメーター
SAMLResponse
パートナープロファイルの作成と保存に必要なユーザーメタデータを含むパートナー認証応答。

値は、Base64 エンコードされた後、URL エンコードされた値である必要があります。
必須
ヘッダー
認証
ベアラートークンのペイロードの生成については、Authorization ヘッダーのドキュメントを参照してください。
必須
コンテンツタイプ
送信されるリソースの許可されたメディアタイプ。

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

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

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

指定しない場合、Adobe Pass認証バックエンドは、抽出された値を暗黙的に（デフォルトで）使用します。
必須
AP-Partner-Framework-Status
パートナーメソッドのシングルサインオンペイロードの生成については、AP-Partner-Framework-Status ヘッダーのドキュメントを参照してください。

パートナーを使用したシングルサインオン対応フローについて詳しくは、 パートナーフローを使用したシングルサインオンのドキュメントを参照してください。
オプション
X-Forwarded-For
ストリーミングデバイスのIP アドレス。

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

クライアントからサーバーへの実装では、ストリーミングデバイスのIP アドレスが暗黙的に送信されます。
オプション
AP-Visitor-Identifier
訪問者識別子ペイロードの生成については、AP-Visitor-Identifier ヘッダーのドキュメントを参照してください。
オプション
承認
クライアントアプリケーションが受け入れたメディアタイプ。

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

応答 response

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

成功 success

ヘッダー
ステータス
201
必須
コンテンツタイプ
アプリケーション/json
必須
本文
プロファイル

キー、値のペアのマップを含むJSON。

キー要素は、次の値で定義されます。

table 0-row-3 1-row-3 1-bgcolor-#eff2f7 2-bgcolor-#eff2f7 3-bgcolor-#eff2f7 5-bgcolor-#deebff layout-auto html-authored
値
mvpd オンボーディングプロセス中にID プロバイダーに関連付けられた内部一意のID。 必須

value エレメントは、次の属性で定義されます。

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-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 layout-auto html-authored
属性
notBefore プロファイルが無効になるまでのタイムスタンプ（ミリ秒単位）。 必須
notAfter プロファイルが無効になるまでのタイムスタンプ（ミリ秒単位）。 必須
イシュア

プロファイルを所有するエンティティ。

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

  • Apple
    このプロファイルは、次の結果として作成されました。パートナーAppleを使用したシングルサインオン。
 必須
タイプ

プロファイルのタイプ。

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

  • appleSSO
    このプロファイルは、次の結果として作成されました。パートナーAppleを使用したシングルサインオン。
 必須
属性

キー、値のペアのマップを含むJSON。

キー要素は、ユーザーのメタデータ属性によって定義され、次の要素を使用できます。

  • 「userID」などの必須
  • 「zip」、「householdID」、「maxRating」など、必須ではないエレメント。

属性の値は次のとおりです。

  • シンプル
  • リスト
  • マップ

認証フローが完了すると、ユーザーメタデータが使用できるようになります。ただし、MVPDと特定のメタデータ属性に応じて、認証フロー中に特定のメタデータ属性が更新される場合があります。

 必須
必須

エラー error

ヘッダー
ステータス
400, 401, 405, 500
必須
コンテンツタイプ
アプリケーション/json
必須
本文

応答本文は、拡張エラーコードドキュメントに準拠する追加のエラー情報を提供する場合があります。

クライアントアプリケーションは、このAPIによって最も一般的に返されるエラーコードを適切に処理できるエラー処理メカニズムを実装する必要があります。

  • invalid_header_pfs_permission_access_not_present
  • invalid_header_pfs_permission_access_not_determined
  • invalid_header_pfs_permission_access_not_granted
  • invalid_header_pfs_provider_id_not_determined
  • invalid_header_pfs_provider_id_mismatch
  • invalid_header_pfs_provider_info_expired
  • invalid_parameter_saml_response
  • など。

上記のリストは網羅的ではありません。 クライアントアプリケーションは、公開ドキュメントで定義されているすべての強化エラーコードを処理できる必要があります。

必須

サンプル samples

​1. パートナー認証応答を使用したプロファイルの作成と取得

リクエスト
code language-https 
POST /api/v2/REF30/profiles/sso/Apple 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==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiQ2FibGV2aXNpb24iLAogICAgICAiZXhwaXJhdGlvbkRhdGUiIDogIjIwMjU0MzA2MzYwMDAiCiAgICB9Cn0=
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...
応答
code language-https 
HTTP/1.1 201 Created

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

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "issuer": "Apple",
            "type": "appleSSO",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        }
     }
}

​2. パートナー認証応答を使用してプロファイルを作成および取得しますが、劣化が適用されます

リクエスト
code language-https 
POST /api/v2/REF30/profiles/sso/Apple 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==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiJHtkZWdyYWRlZE12cGR9IiwKICAgICAgImV4cGlyYXRpb25EYXRlIiA6ICIyMDI1NDMwNjM2MDAwIgogICAgfQp9
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...
応答
code language-https 
HTTP/1.1 200 OK

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

{
    "profiles": {
        "${degradedMvpd}": {
            "notBefore": 1706636062704,
            "notAfter": 1706696062704,
            "issuer": "Adobe",
            "type": "degraded",
            "attributes": {
                "userID": {
                    "value": "95cf93bcd183214ac9e4433153cb8a9d180a463128c0a5d26f202e8c",
                    "state": "plain"
                }
            }
        }
   }
}
recommendation-more-help
pass-help-authentication