IDaaS Open Platform
Customer Identity (CIAM)

API for Exchanging SSO Ticket for User Information

Call this API to exchange an SSO ticket for user information.

# Request Description

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

# Request Headers

Parameter Name Chinese Name Required Type Example
Authorization Authorization Information Yes String Bearer {access_token}
content-type Content Type Yes String application/json

# Request Example

{
    "sso_ticket": "ssoTicket-r5TCBLU14oSGxCMVdxeB5HA1uJiV",
    "operating_sys_version": "windows10.1.1",
    "device_ip": "192.168.1.1",
    "device_fingerprint": "156aysdna213sac",
    "agent": "agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"
}
1
2
3
4
5
6
7

# Request Parameters

Parameter Name Chinese Name Required Type Description
sso_ticket One-time Access Ticket Yes String Obtain the one-time access ticket sso_ticket by exchanging the user's session_token after login. The sso_ticket can be used to retrieve user information.
operating_sys_version Calling Client Operating System Version Yes String Example: windows10.1.1
device_ip Calling Device IP Yes String Example: 192.168.1.2
device_fingerprint Calling Client Device Fingerprint Yes String The value of this parameter must remain consistent for the same user when calling the API. Example: 156aysdna213sac
agent User-Agent Information No String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
	"id": "20220126153857263-A04D-60E0D446C",
	"userName": "zhangsan",
    "name": "zhangsan",
    "mobile": "+86-18310136755",
	"email": "18310136755@163.com"
}
1
2
3
4
5
6
7
8
9
10

# Response Parameters

The platform configuration returns a basic user list, refer to the following

Parameter Name Chinese Name Type Description
userName Username String
id User ID String
name Name String
mobile Mobile Number String
email Email String

Refresh session_token