文档Adobe PassAdobe Pass Authentication

（旧版）REST API参考 rest-api-reference

Last update: Thu Jan 30 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
此页面上的内容仅供参考。 使用此API需要来自Adobe的当前许可证。 不允许未经授权使用。
IMPORTANT
确保随时了解汇总在产品公告页中的最新Adobe Pass身份验证产品公告和停用时间表。

节流机构

Adobe Pass身份验证REST API受限制机制控制。

响应格式 response-formats

NOTE
这些服务中提供的API可以以XML或JSON格式返回响应（对于返回响应的API）。 有3种不同的方法在请求中指定响应格式：
  • 将HTTP接受标头设置为application/xml或application/json。
  • 在请求有效负载中，指定参数format=xml或format=json。
  • 调用扩展名为.xml或.json的Web服务终结点。 例如，/regcode.xml或/regcode.json
您可以指定以上任意一种方法。 使用冲突的格式指定多个方法可能会导致错误或不适当的输出。

REST API端点 clientless-endpoints

<REGGIE_FQDN>：

<SP_FQDN>：

Web服务摘要 web_srvs_summary

下表列出了适用于无客户端方法的Web服务。 单击Web服务端点以了解更多信息（示例请求和响应、输入参数、HTTP方法等）

Sr
Web服务端点
描述
。
托管位置
调用者
1.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
返回随机生成的注册代码和登录页面URI
2
Adobe
注册代码服务
智能设备
2.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
返回包含注册码UUID、注册码和哈希设备ID的注册码记录
8
Adobe
注册代码服务
Adobe Pass 身份验证
3.
<SP_FQDN>/api/v1/config/
{requestorId}
返回请求者的已配置MVPD列表
5
Adobe
Adobe Pass
身份验证
服务
登录
Web
应用程序
4.
<SP_FQDN>/api/v1/authenticate
通过通知MVPD选择事件来启动AuthN流程。 在身份验证数据库上创建记录，在从MVPD收到成功响应时进行协调（步骤13）
7
Adobe
Adobe Pass
身份验证
服务
登录
Web
应用程序
5.
SAML断言消费者
Adobe Pass身份验证与MVPD之间的现有SAML工作流
13
Adobe Pass
身份验证
服务
Adobe Pass 身份验证
6.
<SP_FQDN>/api/v1/checkauthn/
{registrationCode}
登录Web应用程序可以检查尝试的登录流程是否成功
Adobe Pass
身份验证
服务
登录
Web
应用
7.
<SP_FQDN>/api/v1/tokens/authn
获取AuthN令牌相关的元数据
15
Adobe Pass
身份验证
服务
智能设备
8.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
删除注册代码记录并释放注册代码以供重用
16
Adobe
注册代码服务
Adobe Pass 身份验证
9.
<SP_FQDN>/api/v1/authorize
获取授权响应。
17
Adobe Pass
身份验证
服务
智能设备
10.
<SP_FQDN>/api/v1/checkauthn
指示设备是否具有未过期的身份验证令牌。
Adobe Pass
身份验证
服务
智能设备
11.
<SP_FQDN>/api/v1/tokens/authn
如果找到，则返回AuthN标记。
Adobe Pass
身份验证
服务
智能设备
12.
<SP_FQDN>/api/v1/tokens/authz
如果找到，则返回AuthZ令牌。
Adobe Pass
身份验证
服务
智能设备
13.
<SP_FQDN>/api/v1/tokens/media
如果找到，则返回短媒体令牌 — 与/api/v1/mediatoken相同
Adobe Pass
身份验证
服务
智能设备
14.
<SP_FQDN>/api/v1/mediatoken
获取短媒体令牌
Adobe Pass
身份验证
服务
智能设备
15.
<SP_FQDN>/api/v1/preauthorize
检索预授权资源的列表
Adobe Pass
身份验证
服务
智能设备
16.
<SP_FQDN>/api/v1/preauthorize/{code}
检索预授权资源的列表
Adobe Pass
身份验证
服务
登录Web应用程序
17.
<SP_FQDN>/api/v1/logout
从存储中删除AuthN和AuthZ令牌
Adobe Pass
身份验证
服务
智能设备
18.
<SP_FQDN>/api/v1/tokens/usermetadata
在验证流完成后获取用户元数据
不适用
不适用
智能设备
19.
<SP_FQDN>/api/v1/authenticate/freepreview
为临时传递或提升临时传递创建身份验证令牌
不适用
Adobe Pass
身份验证
服务
智能设备

REST API安全性 security

必须使用HTTPS协议调用所有Adobe Pass身份验证REST API，以便进行安全通信。 此外，调用的大多数API应包含按照检索访问令牌 API文档中所述获得的访问令牌。

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b