文档首页/ 应用身份管理服务 OneAccess/ API参考/ API/ 用户类接口/ SSO/ 通过session_token获取sso_ticket
更新时间：2024-10-21 GMT+08:00
查看PDF
分享

通过session_token获取sso_ticket

功能介绍

获取用户信息时，先调用本接口获取sso_ticket。

URI

POST /api/v2/tenant/sso/session-token/sso-ticket

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

Authorization

是

String

认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。

X-tenant-id

否

String

租户外部ID，如果为ISV方调用则为必填，需要将{domain_name}换成ISV通用域名{common_domain}，请求Header参数中需要指定对应租户的tenant_id。
表2 请求Body参数

参数

是否必选

参数类型

描述

session_token

是

String

登录成功返回的会话token。

operating_sys_version

是

String

调用方操作系统版本，例如： Android 10。

device_ip

是

String

调用方设备ip，例如：10.10.10.1。

device_fingerprint

是

String

调用方设备指纹，同一个用户调用接口时该参数的值需和登录接口中的值保持统一，例如：156aysdna213sc50。

agent

否

String

调用方User-Agent信息，例如：Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36。

client_id

否

String

应用授权ID，获取用户信息时如果想获取的是单点应用的用户信息，则需要传入单点应用的client_id。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

expire

Integer

过期时间，单位秒。

sso_ticket

String

一次性票据，通过用户登录后的session_token获取一次性访问票据sso_ticket，通过sso_ticket可以获取用户信息。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误详情。

请求示例

通过登录成功后响应得到值为iJK******ITu的session_token获取sso_ticket。

POST https://{domain_name}/api/v2/tenant/sso/session-token/sso-ticket

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

{
  "session_token": "iJK******ITu",
  "operating_sys_version": "Android 10",
  "device_ip": "10.10.10.1",
  "device_fingerprint": "156aysdna213sac",
  "agent": "Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36",
  "client_id": "9fIHl3Dc9ivToWLVtblrF6Sjv9Fx47JJ"
}

响应示例

状态码： 200

请求成功。

{
  "expire" : 9600,
  "sso_ticket" : "cd7******yjn"
}

状态码

状态码

描述

200

请求成功。

400

参数无效。

错误码

请参见错误码。

父主题： SSO

相关文档