主题
刷新AccessToken
Access Token过期后需要用户重新授权才能获得新的Access Token。本步骤可以实现授权自动续期,避免要求用户再次授权的操作,提升用户体验
接口说明
请求URL:http[s]://{认证地址}/authserver/oauthApi/token/refresh
请求方式: POST
请求内容类型: application/x-www-form-urlencoded
响应内容类型: application/json
请求说明
请求体
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 刷新令牌 | refresh_token | M | String | 获取AccessToken时获取的刷新令牌 |
响应说明
响应体
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 授权令牌 | access_token | +M | String | 颁发给应用的授权访问令牌,用于调用接口使用 |
| 令牌类型 | token_type | +M | String | 颁发的令牌的类型,目前固定为Bearer |
| 授权令牌的有效期 | expires_in | +M | String | 授权访问令牌的生命周期,单位为秒 |
| 刷新令牌 | refresh_token | +M | String | 刷新令牌 |
响应示例
json
{
"access_token":"[ACCESS_TOKEN]",
"token_type":"Bearer",
"expires_in":"72000",
"refresh_token":"[REFRESH_TOKEN]"
}1
2
3
4
5
6
2
3
4
5
6
错误码
如果请求不合法或者相关验证不通过,授权服务器会返回相应的错误信息,包含以下参数:error、error_code、error_description、error_uri、state。
参数说明表
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 授权码 | error | M | String | 错误信息 |
| 错误的内部编号 | error_code | M | String | 错误的内部编号 |
| 错误的描述信息 | error_description | M | String | 错误的描述信息 |
| 错误地址 | error_uri | O | String | 可读的网页URI, 带有关于错误的信息, 用于为终端用户提供与错误有关的额外信息。 |
授权错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
| 10001 | request missing param | 请求缺少参数 |
| 10002 | request invalid param | 请求的参数值不合法,参数值与规定值不符 |
| 10003 | client identification is invalid | 客户端标识不合法(client_id或client_secret错误) |
| 10004 | redirect_uri is not match | 传递的redirect_uri跟注册的回调地址不匹配 |
| 10005 | missing redirect_uri | 缺少回调地址 |
| 10006 | authentication is failed | 认证失败或超时 |
| 10007 | current authentication is invalid | 无效的认证 |
| 10008 | session is expired | session过期 |
| 10009 | authorize code is invalid | 提供的授权码无效、过期或者已被吊销 |
| 10010 | request method is error | 接口的请求方法错误 |
接口API错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
| 20001 | no_authorization | 缺失访问该接口的权限 |
| 20002 | missing_accessToken | 缺失访问令牌access token |
| 20003 | invalid_accessToken | 访问令牌access token无效、过期或吊销 |
| 20004 | missing_parameter | 参数缺失 |
| 20005 | invalid_refreshToken | 刷新令牌无效、过期或吊销 |

