ヘッダー – AP-Partner-Framework-Status header-ap-partner-framework-status

Last update: Mon Aug 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
認証

NOTE

このページのコンテンツは情報提供のみを目的としています。この API を使用するには、Adobeから現在のライセンスが必要です。無許可の使用は許可されていません。

概要 overview

AP-Partner-Framework-Status 要求ヘッダーには、シングルサインオン（SSO）を実現するためにパートナーフレームワークから取得した状態情報が含まれています。

構文 syntax

AP-Partner-Framework-Status: <partner_framework_status_information>

ヘッダータイプ

リクエストヘッダー

標準

不可

ディレクティブ directives

<partner_framework_status_information>

次の属性を含む JSON 要素の Base64-encoded 値：

属性

frameworkPermissionInfo

これは必須の属性です。

パートナーフレームワークによって返され、アプリケーションによって処理されるユーザー権限ステータス情報。

これは、次の属性を持つ JSON 要素です。

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 10-bgcolor-eff2f7 11-bgcolor-eff2f7 html-authored

属性

accessStatus

これは必須の属性です。

これは、次の値を含む列挙です。

承認済み – ユーザーはアプリケーションが購読情報にアクセスできるようにしました。
拒否 – ユーザーが、購読情報にアクセスするためのアプリケーションを拒否しました。
保留中 – アプリケーションが購読情報にアクセスできるようにするためのオプションがユーザーによってまだ選択されていません。
notDetermined - アプリケーションが購読情報にアクセスできません。

エラー

これはオプションの属性です。

これは、ユーザー権限のステータス情報のクエリ中にパートナーフレームワークエラーがトリガーされた場合に、パートナーフレームワークエラーを渡すために使用できます。

これは、次の属性を持つ JSON 要素です。

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
属性
コード	パートナーフレームワークによって定義されたエラーを一意に識別する文字列。
メッセージ	パートナーフレームワークで定義されたエラーの説明を含む文字列。

frameworkProviderInfo

これは必須の属性です。

パートナーフレームワークによって返され、アプリケーションによって処理される、プロバイダーのログインステータス情報。

これは、次の属性を持つ JSON 要素です。

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 13-bgcolor-eff2f7 14-bgcolor-eff2f7 html-authored

属性

これは必須の属性です。

これは、パートナーフレームワークレベルでの認証フロー中に使用される MVPD を識別する mappingId です。

expirationDate

これは必須の属性です。

ユーザーがパートナーフレームワークレベルでサポートされている MVPD を使用して正常にログに記録された場合、これは、認証済みユーザープロファイルの有効期限です。

エラー

これはオプションの属性です。

これは、プロバイダーログインステータス情報のクエリ中にパートナーフレームワークエラーがトリガーされた場合に、パートナーフレームワークエラーを渡すために使用できます。

これは、次の属性を持つ JSON 要素です。

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
属性
コード	パートナーフレームワークによって定義されたエラーを一意に識別する文字列。
メッセージ	パートナーフレームワークで定義されたエラーの説明を含む文字列。

例 examples

// Partner framework status information
// {
//    "frameworkPermissionInfo": {
//        "accessStatus": "....",
//        "error": {
//            "code" : "....",
//            "message" : "...."
//        }
//     },
//    "frameworkProviderInfo" : {
//        "id" : "....",
//        "expirationDate" : "....",
//        "error" : {
//            "code" : "...",
//            "message" : "....."
//        }
//     }
// }

// Base64-encoded
// ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAgICJhY2Nlc3NTdGF0dXMiOiAiLi4uLiIsCiAgICAgICAg
// ImVycm9yIjogewogICAgICAgICAgICAiY29kZSIgOiAiLi4uLiIsCiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uIgogICAg
// ICAgIH0KICAgIH0sCiAgICAiZnJhbWV3b3JrUHJvdmlkZXJJbmZvIiA6IHsKICAgICAgICAiaWQiIDogIi4uLi4iLAogICAgICAg
// ICJleHBpcmF0aW9uRGF0ZSIgOiAiLi4uLiIsCiAgICAgICAgImVycm9yIiA6IHsKICAgICAgICAgICAgImNvZGUiIDogIi4uLiIs
// CiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uLiIKICAgICAgICB9CiAgICB9Cn0gIA==

AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAgICJhY2Nlc3NTdGF0dXMiOiAiLi4uLiIsCiAgICAgICAgImVycm9yIjogewogICAgICAgICAgICAiY29kZSIgOiAiLi4uLiIsCiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uIgogICAgICAgIH0KICAgIH0sCiAgICAiZnJhbWV3b3JrUHJvdmlkZXJJbmZvIiA6IHsKICAgICAgICAiaWQiIDogIi4uLi4iLAogICAgICAgICJleHBpcmF0aW9uRGF0ZSIgOiAiLi4uLiIsCiAgICAgICAgImVycm9yIiA6IHsKICAgICAgICAgICAgImNvZGUiIDogIi4uLiIsCiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uLiIKICAgICAgICB9CiAgICB9Cn0gIA==

recommendation-more-help

3f5e655c-af63-48cc-9769-2b6803cc5f4b