文档Adobe PassAdobe Pass 身份验证

使用代码检索身份验证会话 retrieve-authentication-session-using-code

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

请求 request

HTTP
路径
/api/v2/{serviceProvider}/sessions/{code}
方法
GET
路径参数
serviceProvider
在载入过程中与服务提供商关联的内部唯一标识符。
必填
代码
在流设备上创建身份验证会话后获得的身份验证代码。
必填
标头
授权
授权标头文档中描述了持有者令牌有效负载的生成。
必填
X-Forwarded-For
流设备的IP地址。

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

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

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

响应 response

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

成功 success

标头
状态
200
必填
正文

具有以下属性的JSON对象：

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
属性
existingparameters 已提供的现有参数。 必填
missingParameters 需要提供以便完成身份验证流程的缺失参数。 可选
设备 与实际的流设备相关的设备信息。 必填
notBefore 身份验证代码无效之前的时间戳（以毫秒为单位）。 必填
notAfter 身份验证代码无效的时间戳（以毫秒为单位）。 必填
必填

错误 error

标头
状态
400, 401, 405, 500
必填
Content-Type
application/json
必填
正文

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

客户端应用程序必须实施一种错误处理机制，该机制能够正确处理此API最常返回的错误代码：

  • invalid_authentication_session
  • invalid_parameter_code
  • 等等。

以上列表并非详尽无遗。 客户端应用程序必须能够处理公共文档中定义的所有增强型错误代码。

必填

示例 samples

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

请求
code language-https 
GET /api/v2/sessions/REF30/8BLW4RW HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
响应
code language-https 
HTTP/1.1 200 OK

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

{
    "existingParameters": {
        "mvpd": "apassidp",
        "domain": "adobe.com"
        "redirectUrl": "https://www.adobe.com",
        "serviceProvider": "REF30"
    },
    "device": {
        "type": "Desktop",
        "model": null,
        "version": {
            "major": 0,
            "minor": 0,
            "patch": 0,
            "profile": ""
        },
    "hardware": {
      "name": null,
      "vendor": "Apple",
      "version": {
        "major": 0,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "manufacturer": "Apple"
    },
    "operatingSystem": {
      "name": "macOS",
      "family": "macOS",
      "vendor": "Apple",
      "version": {
        "major": 10,
        "minor": 15,
        "patch": 7,
        "profile": ""
      }
    },
    "browser": {
      "name": "Chrome",
      "vendor": "Google",
      "version": {
        "major": 140,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36",
      "originalUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"
    },
    "display": {
      "width": 0,
      "height": 0,
      "ppi": 0,
      "name": "DISPLAY",
      "vendor": null,
      "version": null,
      "diagonalSize": null
    },
    "applicationId": null,
    "connection": {
      "ipAddress": "...",
      "port": "55161",
      "secure": false,
      "type": null
    }
    }
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

​1. 使用缺少的参数检索身份验证会话

请求
code language-https 
GET /api/v2/sessions/REF30/8BLW4RW HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
响应
code language-https 
HTTP/1.1 200 OK

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

{
  "missingParameters": [
    "mvpd"
  ],
  "existingParameters": {
    "redirectUrl": "https://adobe.com",
    "domainName": "adobe.com",
    "serviceProvider": "REF30"
  },
  "device": {
    "type": "Desktop",
    "model": null,
    "version": {
      "major": 0,
      "minor": 0,
      "patch": 0,
      "profile": ""
    },
    "hardware": {
      "name": null,
      "vendor": "Apple",
      "version": {
        "major": 0,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "manufacturer": "Apple"
    },
    "operatingSystem": {
      "name": "macOS",
      "family": "macOS",
      "vendor": "Apple",
      "version": {
        "major": 10,
        "minor": 15,
        "patch": 7,
        "profile": ""
      }
    },
    "browser": {
      "name": "Chrome",
      "vendor": "Google",
      "version": {
        "major": 140,
        "minor": 0,
        "patch": 0,
        "profile": ""
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36",
      "originalUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"
    },
    "display": {
      "width": 0,
      "height": 0,
      "ppi": 0,
      "name": "DISPLAY",
      "vendor": null,
      "version": null,
      "diagonalSize": null
    },
    "applicationId": null,
    "connection": {
      "ipAddress": "...",
      "port": "3061",
      "secure": false,
      "type": null
    }
  },
  "notBefore": "1761299929958",
  "notAfter": "1761301729958"
}
recommendation-more-help
pass-help-authentication