ドキュメントAdobe PassAdobe Pass 認証

ヘッダー – AP-Partner-Framework-Status

最終更新日: 2025年3月5日
  • トピック:
  • 認証
メモ
このページのコンテンツは情報提供のみを目的としています。 この API を使用するには、Adobeの最新ライセンスが必要です。 無許可の使用は許可されていません。

概要

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

構文

AP-Partner-Framework-Status: <partner_framework_status_information>
ヘッダータイプリクエストヘッダー
標準不可

ディレクティブ

<partner_framework_status_information>

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

属性
frameworkPermissionInfo

これは必須の属性です。

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

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

属性
accessStatus

これは必須の属性です。

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

  • granted
    ユーザーは、アプリケーションが購読情報にアクセスできるようにしました。
  • 拒否
    ユーザーが、購読情報へのアクセスを求めるアプリケーションを拒否しました。
  • 保留中
    アプリケーションが購読情報にアクセスできるようにするための選択がまだ行われていません。
  • notDetermined
    アプリケーションはサブスクリプション情報にアクセスできません。
エラー

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

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

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

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

これは必須の属性です。

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

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

属性
idこれは必須の属性です。

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

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

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

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

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

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

例

// 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