创建身份验证会话 create-authentication-session

最近更新： 2026年7月7日

主题：
Authentication

IMPORTANT

此页面上的内容仅供参考。使用此API需要来自Adobe的当前许可证。不允许未经授权使用。

IMPORTANT

REST API V2实施受限制机制文档限制。

请求 request

HTTP

路径

/api/v2/{serviceProvider}/sessions

方法

POST

路径参数

serviceProvider

在载入过程中与服务提供商关联的内部唯一标识符。

必填

正文参数

mvpd

在新用户引导过程中与身份提供商关联的内部唯一标识符。

如果流设备平台在提供值方面存在限制，则应用程序必须恢复身份验证会话并提供有效值。

必填

域名

执行MVPD登录的应用程序的原始域。

如果流设备平台在提供值方面存在限制，则应用程序必须恢复身份验证会话并提供有效值。

必填

redirectUrl

MVPD的身份验证流程完成后，用户代理将导航到的最终重定向URL。

该值必须为URL编码。

如果流设备平台在提供值方面存在限制，则应用程序必须恢复身份验证会话并提供有效值。

必填

标头

授权

授权标头文档中描述了持有者令牌有效负载的生成。

必填

Content-Type

所发送资源的接受媒体类型。

必须是application/x-www-form-urlencoded。

必填

AP设备标识符

AP-Device-Identifier标头文档中描述了设备标识符有效负载的生成。

必填

X-Device-Info

X-Device-Info标头文档中介绍了设备信息有效负载的生成。

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

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

如果未提供，Adobe Pass身份验证后端将隐式使用提取的值（默认情况下）。

必填

X-Forwarded-For

流设备的IP地址。

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

对于客户端到服务器实施，流设备的IP地址将隐式发送。

可选

Adobe-Subject-Token
或
X-Roku-Reserved-Roku-Connect-Token

Adobe-Subject-Token / X-Roku-Reserved-Roku-Connect-Token标头文档中介绍了为Platform Identity方法生成单点登录有效负载的过程。

有关使用平台标识启用单点登录的流的更多详细信息，请参阅使用平台标识流的单点登录文档。

可选

AD-Service-Token

AD-Service-Token标头文档介绍了服务令牌方法单点登录有效负载的生成。

有关使用服务令牌启用单点登录的流的更多详细信息，请参阅使用服务令牌流的单点登录文档。

可选

AP-Visitor-Identifier

AP-Visitor-Identifier标头文档中描述了访客标识符有效负载的生成。

可选

客户端应用程序接受的媒体类型。

如果指定，则必须为application/json；charset=utf-8。

可选

User-Agent

客户端应用程序的用户代理。

可选

响应 response

代码

文本

描述

200

确定

响应正文包含有关执行身份验证所需的后续操作的信息。

400

错误请求

请求无效，客户端需要更正请求并重试。响应正文可能包含遵守增强型错误代码文档的错误信息。

401

未授权

访问令牌无效，客户端需要获取新的访问令牌并重试。有关更多详细信息，请参阅动态客户端注册概述文档。

405

不允许使用该方法

HTTP方法无效，客户端需要使用请求资源允许的HTTP方法并重试。有关更多详细信息，请参阅请求部分。

500

内部服务器错误

服务器端遇到问题。响应正文可能包含遵守增强型错误代码文档的错误信息。

成功 success

标头

状态

200

必填

Content-Type

application/json

必填

正文

具有以下属性的JSON对象：

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-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 25-bgcolor-#deebff 29-bgcolor-#deebff 33-bgcolor-#deebff 37-bgcolor-#deebff 41-bgcolor-#deebff 45-bgcolor-#deebff layout-auto html-authored
属性
actionName	流设备完成身份验证流程所需执行的操作。可能的值包括：身份验证流设备或其他设备需要在用户代理中打开提供的URL。 resume 流设备或其他设备需要提供缺少的参数并使用代码恢复身份验证会话。授权流式设备可以直接继续决策流程。	必填
actionType	流设备必须执行的交互类型，以便通过“actionName”属性指定的操作继续流程。可能的值包括：交互式流继续使用用户代理导航到提供的URL。 direct 流继续使用可用于客户端实施的HTTP客户端直接调用提供的URL。	必填
原因类型	说明“actionName”的原因类型。可能的值包括：无需要客户端应用程序才能继续验证。已通过身份验证客户端应用程序已通过基本访问流进行身份验证。临时客户端应用程序已通过临时访问流进行身份验证。已降级客户端应用程序已通过降级的访问流进行身份验证。 authenticatedSSO 客户端应用程序已通过单点登录访问流验证。	必填
missingParameters	需要提供以完成基本身份验证流程的缺失参数。	可选
url	客户端应用程序需要导航的URL。	可选
代码	可用于辅助应用程序以恢复身份验证会话的身份验证代码。	可选
sessionId	可用于跟踪用户活动的不透明标识符。	必填
mvpd	在新用户引导过程中与身份提供商关联的内部唯一标识符。	可选
serviceProvider	在载入过程中与服务提供商关联的内部唯一标识符。	必填
notBefore	身份验证代码无效之前的时间戳（以毫秒为单位）。	可选
notAfter	身份验证代码无效的时间戳（以毫秒为单位）。	可选

必填

错误 error

标头

状态

400, 401, 405, 500

必填

Content-Type

application/json

必填

正文

响应正文可能提供附加的错误信息，这些信息将遵循增强型错误代码文档。

必填

示例 samples

1. 创建身份验证会话，但不缺少参数

请求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

响应

code language-https

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authenticate",
    "actionType": "interactive",
    "reasonType": "none",
    "url": "/api/v2/authenticate/REF30/8ER640M",
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30",
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

2. 创建缺少参数的身份验证会话

请求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

响应

code language-https

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "resume",
    "actionType": "direct",
    "reasonType": "none",
    "url": "/api/v2/REF30/sessions/8ER640M",
    "missingParameters": ["mvpd", "domain", "redirectUrl"],
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "serviceProvider": "REF30",
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

3. 在有效配置文件已存在时创建身份验证会话

请求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

响应

code language-https

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "authenticated",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

4. 使用基本或提升TempPass创建身份验证会话（非必需）

请求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=TempPass_TEST40&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

响应

code language-https

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "temporary",
    "url": "/api/v2/REF30/decisions/authorize/TempPass_TEST40",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "TempPass_TEST40",
    "serviceProvider": "REF30"
}

5. 在应用降级时创建身份验证会话

请求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

响应

code language-https

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "degraded",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

recommendation-more-help

pass-help-authentication

创建身份验证会话 create-authentication-session

请求 request

响应 response

成功 success

错误 error

示例 samples

​1. 创建身份验证会话，但不缺少参数

​2. 创建缺少参数的身份验证会话

​3. 在有效配置文件已存在时创建身份验证会话

​4. 使用基本或提升TempPass创建身份验证会话（非必需）

​5. 在应用降级时创建身份验证会话

1. 创建身份验证会话，但不缺少参数

2. 创建缺少参数的身份验证会话

3. 在有效配置文件已存在时创建身份验证会话

4. 使用基本或提升TempPass创建身份验证会话（非必需）

5. 在应用降级时创建身份验证会话