Customer Identity (CIAM)
API for Exchanging sessiontoken for ssoticket
When retrieving user information, call this API first to exchange for an sso_ticket.
# Request Specification
POST https://{your_domain}/api/v2/tenant/sso/session-token/sso-ticket
# Request Headers
| Parameter | Chinese 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"
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# Request Parameters
| Parameter | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| session_token | Token returned upon successful user login | Yes | String | |
| operating_sys_version | Operating system version of the calling client | Yes | String | Example: windows10.1.1 |
| device_ip | IP address of the calling device | Yes | String | Example: 192.168.1.2 |
| device_fingerprint | Device fingerprint of the calling client | 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) |
# Return Example
Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
"expire": 300,
"sso_ticket": "ssoTicket-y0w1ODvy7v0000nCa91OYoj1Bzxqfesy"
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# Return Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| expire | Expiration Time | Number | |
| sso_ticket | One-time Ticket | String | Exchange a one-time access ticket sso_ticket based on the user's session_token after login; sso_ticket can be used to obtain user information |