Exchange session_token for sso_ticket API

When exchanging user information, first call this API to exchange for sso_ticket.

Request Description

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

Request Headers

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

Request Example

{
    "session_token": "iJKVWQVfFvIQWffsTlSxTf02MV3dpITu", 
    "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"
}

Request Parameters

Parameter Name	Name	Required	Type	Description
session_token	Token returned after user login success	Yes	String
operating_sys_version	Caller client operating system version	Yes	String	Example: windows10.1.1
device_ip	Caller client device IP	Yes	String	Example: 192.168.1.2
device_fingerprint	Caller client device fingerprint	Yes	String	This parameter value needs to remain consistent when the same user calls 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

{
    "expire": 300, 
    "sso_ticket": "ssoTicket-y0w1ODvy7v0000nCa91OYoj1Bzxqfesy"
}

Response Parameters

Parameter Name	Name	Type	Description
expire	Expiration time	Number
sso_ticket	One-time ticket	String	Exchange one-time access ticket sso_ticket using session_token after user login; sso_ticket can be exchanged for user information