文档Adobe PassAdobe Pass 身份验证

使用合作伙伴身份验证响应创建和检索配置文件 create-and-retrieve-profile-using-partner-authentication-response

最近更新： 2026年7月7日
IMPORTANT
此页面上的内容仅供参考。 使用此API需要来自Adobe的当前许可证。 不允许未经授权使用。
IMPORTANT
REST API V2实施受限制机制文档限制。

请求 request

HTTP
路径
/api/v2/{serviceProvider}/profiles/sso/{partner}
方法
POST
路径参数
serviceProvider
在载入过程中与服务提供商关联的内部唯一标识符。
必填
合作伙伴
提供与Adobe Pass身份验证流集成的单点登录框架的合作伙伴的名称（例如Apple）。
必填
正文参数
SAMLResponse
包含创建和保存合作伙伴配置文件所需的用户元数据的合作伙伴身份验证响应。

该值必须为Base64编码和随后的URL编码。
必填
标头
授权
授权标头文档中描述了持有者令牌有效负载的生成。
必填
Content-Type
所发送资源的接受媒体类型。

必须是application/x-www-form-urlencoded。
必填
AP设备标识符
AP-Device-Identifier标头文档中描述了设备标识符有效负载的生成。
必填
X-Device-Info
X-Device-Info标头文档中介绍了设备信息有效负载的生成。

强烈建议在应用程序的设备平台允许显式提供有效值时始终使用它。

提供该属性后，Adobe Pass身份验证后端将隐式地将显式设置的值与提取的值合并（默认情况下）。

如果未提供，Adobe Pass身份验证后端将隐式使用提取的值（默认情况下）。
必填
AP — 合作伙伴 — 框架 — 状态
AP-Partner-Framework-Status标头文档介绍了为Partner方法生成单一登录有效负载的过程。

有关使用合作伙伴启用单点登录流程的更多详细信息，请参阅使用合作伙伴流程进行单点登录文档。
可选
X-Forwarded-For
流设备的IP地址。

强烈建议始终将其用于服务器到服务器的实施，尤其是在由程序员服务而不是流设备进行调用时。

对于客户端到服务器实施，流设备的IP地址将隐式发送。
可选
AP-Visitor-Identifier
AP-Visitor-Identifier标头文档中描述了访客标识符有效负载的生成。
可选
Accept
客户端应用程序接受的媒体类型。

如果指定，则必须为application/json；charset=utf-8。
可选
User-Agent
客户端应用程序的用户代理。
可选

响应 response

代码
文本
描述
201
已创建
响应正文包含有效配置文件的映射，该映射可能为空。
400
错误请求
请求无效，客户端需要更正请求并重试。 响应正文可能包含遵守增强型错误代码文档的错误信息。
401
未授权
访问令牌无效，客户端需要获取新的访问令牌并重试。 有关更多详细信息，请参阅动态客户端注册概述文档。
405
不允许使用该方法
HTTP方法无效，客户端需要使用请求资源允许的HTTP方法并重试。 有关更多详细信息，请参阅请求部分。
500
内部服务器错误
服务器端遇到问题。 响应正文可能包含遵守增强型错误代码文档的错误信息。

成功 success

标头
状态
201
必填
Content-Type
application/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 在新用户引导过程中与身份提供商关联的内部唯一标识符。 必填

值元素由以下属性定义：

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进行单点登录。
 必填
type

配置文件的类型。

可能的值包括：

  • appleSSO
    创建配置文件的原因是：使用合作伙伴Apple进行单点登录。
 必填
属性

JSON包含键、值对的映射。

关键元素由用户元数据属性定义，可以是：

  • 必填，如“userID”
  • 非强制性的，如“zip”、“householdID”、“maxRating”等。

属性的值可以是：

  • 简单
  • 列表
  • 映射

在身份验证流程完成后，用户元数据将变为可用，但在授权流程期间，某些元数据属性可能会更新，具体取决于MVPD和有问题的特定元数据属性。

 必填
必填

错误 error

标头
状态
400, 401, 405, 500
必填
Content-Type
application/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
  • 无效的_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