頁首 — 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

這是必要屬性。

此為具有下列可能值的列舉：

granted — 使用者允許應用程式存取訂閱資訊。
拒絕 — 使用者拒絕應用程式存取訂閱資訊。
擱置中 — 使用者尚未選擇允許應用程式存取訂閱資訊。
notDetermined — 不允許應用程式存取訂閱資訊。

錯誤

這是選擇性屬性。

如果在查詢使用者許可權狀態資訊時觸發了合作夥伴架構錯誤，則可以使用此項來傳遞合作夥伴架構錯誤。

這是具有下列屬性的JSON元素：

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
屬性
程式碼	如合作夥伴架構所定義，可唯一識別錯誤的字串。
message	包含合作夥伴框架所定義之錯誤描述的字串。

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

屬性

這是必要屬性。

這是mappingId，可識別合作夥伴架構層級的驗證流程中所使用的MVPD。

expirationdate

這是必要屬性。

這是已驗證使用者設定檔的到期日，以防使用者已在合作夥伴架構層級使用支援的MVPD成功登入。

錯誤

這是選擇性屬性。

若在查詢提供者登入狀態資訊時觸發了合作夥伴架構錯誤，則可使用此項來傳遞合作夥伴架構錯誤。

這是具有下列屬性的JSON元素：

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
屬性
程式碼	如合作夥伴架構所定義，可唯一識別錯誤的字串。
message	包含合作夥伴框架所定義之錯誤描述的字串。

範例 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