客户身份(CIAM)
刷新id_token
调用本接口会对id_token进行刷新，若配置了session_token自动刷新，那么本接口也会对session_token进行刷新。应用需要保存新的session_token。若未配置session_token自动更新，那么返回的是原session_token与新的id_token。
# 请求说明
POST https://{your_domain}/api/v2/sdk/sso/session-token/id-token
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 示例 |
|---|---|---|---|---|
| X-operating-sys-version | 调用方客户端操作系统版本 | 是 | String | windows10.1.1 |
| X-device-fingerprint | 调用方客户端设备指纹 | 是 | String | 156aysdna213sc50 |
| X-device-ip | 调用方客户端IP | 否 | String | 192.168.1.2 |
| X-agent | User-Agent信息 | 是 | String | Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) |
| X-L | 用于国际化语言设置 | 否 | String | zh |
| X-client-id | 应用授权ID | 是 | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| session-token | 会话令牌 | 是 | String | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN |
| content-type | 内容格式类型 | 是 | String | application/json |
# 请求示例
无
# 请求参数
无
# 返回示例
成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
"session_token":"nRUxqRE5TSlQwd3NBIiwiaW",
"expire": 604800,
"id_token": "eyJraWQiOiI0NjJXEuY29tIn0.Jz3pZhvpVQDK99SSwR_SnJE1w0.69wHREjAhMw4Q2uo7CX"
}
错误示例：
HTTP/1.1 400 Bad Request
{
"error_code": "IDAAS.SDK.PARAM.0023",
"error_msg": "Invalid or expired session token"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 返回参数
| 参数名 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| expire | session_token有效期 | Number | session_token有效期，有效期内可使用session_token获取id_token |
| session_token | 用户session_token | String | 用户session_token，可使用该token调用IDaas接口获取新的id_token |
| id_token | 短期有效，接口调用令牌 | String | 该字段为jwt格式，包含用户身份信息。可参考根据id_token获取用户信息获取用户信息。令牌有效期默认为5分钟。 |
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | IDAAS.SDK.PARAM.0001 | Device information is incomplete | 请检查输入的设备信息是否完整 |
| 设备信息不完整 | |||
| 400 | IDAAS.SDK.PARAM.0002 | clientId cannot be empty | 请检查输入的clientId是否为空 |
| clientId不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0003 | The app is not registered, please register the app first | 请检查输入的clientId是否正确 |
| 应用未注册，请先注册应用 | |||
| 400 | IDAAS.SDK.PARAM.0022 | Session token cannot be empty | 请检查输入的会话令牌是否为空 |
| 会话令牌不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0023 | Invalid or expired session token | 请重新获取会话令牌后再试 |
| 会话令牌无效或已过期 | |||
| 400 | IDAAS.SDK.COM.0002 | System busy, please try again later | 请重新调用或联系竹云工作人员 |
| 系统繁忙，请稍后再试 |