通过sso_ticket获取用户信息 - ShowUserBySSOTicket

功能介绍

通过sso_ticket获取用户信息。

URI

POST /api/v2/tenant/sso/sso-ticket/verify

请求参数

表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参数
参数	是否必选	参数类型	描述
sso_ticket	是	String	一次性访问票据，通过用户登录后的session_token获取一次性访问票据sso_ticket，通过sso_ticket可以获取用户信息。
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。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
code	String	错误码。
message	String	错误描述。
data	data object	用户信息。

表4 data
参数	参数类型	描述
user	UserInfoDataResult object	用户信息。

表5 UserInfoDataResult
参数	参数类型	描述
userName	String	用户名。
id	String	用户id。
name	String	姓名。
mobile	String	手机号。
email	String	邮箱。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误详情。

请求示例

通过session_token换取的sso_ticket查询用户信息，sso_ticket值为ssoTicket-r5TCBLU14oSGxCMVdxeB5HA1uJiV。

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

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

{
  "sso_ticket": "ssoTicket-r5TCBLU14oSGxCMVdxeB5HA1uJiV",
  "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"
}

响应示例

状态码：200

请求成功。

{
  "code" : "0",
  "message" : "success",
  "data" : {
    "user" : {
      "name" : "20220330162435",
      "mobile" : "12345678901",
      "id" : "20220330162436475-7570-D943B4FF3",
      "userName" : "20220330162435",
      "email" : "20220330162435@example.com"
    }
  }
}