Customer Identity (CIAM)
Refresh session_token API
Call this API when refreshing the session_token.
# Request Description
POST https://{your_domain}/api/v2/tenant/sso/session-token/refresh
# Request Headers
| Parameter Name | 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 Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| session_token | Token after user login | Yes | String | Exchange the user's post-login session_token for a new session_token |
| operating_sys_version | Calling client's operating system version | Yes | String | For example: windows10.1.1 |
| device_ip | Calling device IP | Yes | String | For example: 192.168.1.2 |
| device_fingerprint | Calling client device fingerprint | Yes | String | The value of this parameter must remain consistent when the same user calls the API. For 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
{
"expire": 43200,
"session_token": "oRf5WQVfFvIQerrjTlSxTf02MV3pr8n2"
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# Response Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| expire | session_token Validity Period | Number | The validity period of the session_token, within which the session_token can be used to obtain a ticket |
| session_token | User's New session_token | String | The user's session_token, which can be used to call IDaaS APIs to obtain an sso_ticket. The sso_ticket can be exchanged for user information |
