Help Center/ OneAccess/ API Reference/ OneAccess APIs/ User APIs/ SSO/ Obtaining User Information Using sso_ticket

Updated on 2024-12-30 GMT+08:00

View PDF

Obtaining User Information Using sso_ticket

Function

This API is used to obtain user information using sso_ticket.

URI

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

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Set this field to "application/json;charset=utf8".
Authorization	Yes	String	Authentication credential. The value is Bearer {access_token}. access_token is obtained by calling the API for obtaining an access credential.
X-tenant-id	No	String	External ID of a tenant. This parameter is mandatory if the API is called by an ISV. Replace "{domain_name}" with the ISV common domain name "{common_domain}". The tenant ID of the corresponding tenant must be specified in the request header.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
sso_ticket	Yes	String	One-time access ticket (sso_ticket), which is obtained using session_token upon user login, and used to obtain user information.
operating_sys_version	Yes	String	Caller OS version, for example, Android 10.
device_ip	Yes	String	Caller device IP address, for example, 10.10.10.1
device_fingerprint	Yes	String	Caller device fingerprint. When the same user calls the API, values of this parameter must be the same, for example, 156aysdna213sc50.
agent	No	String	User agent information of the caller, for example, 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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Error code.
message	String	Error description.
data	data object	User information.

**Table 4** data
Parameter	Type	Description
user	UserInfoDataResult object	User information.

**Table 5** UserInfoDataResult
Parameter	Type	Description
userName	String	Username.
id	String	User ID.
name	String	Name.
mobile	String	Mobile number.
email	String	Email address.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Query user information based on sso_ticket obtained from session_token. The value of sso_ticket is 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"
}

Example Responses

Status code: 200

Request successful.

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