标头 — AP-Partner-Framework-Status header-ap-partner-framework-status

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

主题：
Authentication

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

属性

访问状态

这是必需属性。

这是具有以下可能值的枚举：

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。

过期日期

这是必需属性。

这是经过身份验证的用户配置文件的过期日期，以防用户已在合作伙伴框架级别使用支持的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