刷新session_token
功能介绍
刷新session_token。
URI
POST /api/v2/tenant/sso/session-token/refresh
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
该字段内容填为“application/json;charset=utf8”。 |
Authorization |
是 |
String |
认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。 |
X-tenant-id |
否 |
String |
租户外部ID，如果为ISV方调用则为必填，需要将{domain_name}换成ISV通用域名{common_domain}，请求Header参数中需要指定对应租户的tenant_id。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
session_token |
是 |
String |
用户登录后的session_token。 |
operating_sys_version |
是 |
String |
调用方操作系统版本，例如： Android 10。 |
device_ip |
是 |
String |
调用方设备ip，例如：10.10.10.1。 |
device_fingerprint |
是 |
String |
调用方设备指纹，同一个用户调用接口时该参数的值需保持统一，例如：156aysdna213sc50。 |
agent |
否 |
String |
调用方User-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。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
session_token |
String |
用户新的session_token，可使用该token调用单点登录接口获取sso_ticket，通过sso_ticket可以获取用户信息。 |
id_token |
String |
本质上是一个JWT Token，包含了用户身份信息，默认2小时有效，支持可配置。 |
expire |
Integer |
过期时间，单位为秒。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误详情。 |
请求示例
根据用户登录成功后获取值为r5y******LU1的session_token再刷新session_token。
POST https://{domain_name}/api/v2/tenant/sso/session-token/refresh
Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21
{
"session_token": "r5y******LU1",
"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"
}
响应示例
状态码： 200
请求成功。
{
"session_token" : "lqI******JFH"
}
状态码
状态码 |
描述 |
|---|---|
200 |
请求成功。 |
400 |
参数无效。 |
错误码
请参见错误码。
