文档首页/ 华为云DocZip智能文档服务/ API参考/ API/ 身份与授权/ 刷新令牌 - RefreshEmbedAuthToken
更新时间:2026-10-22 GMT+08:00
分享

刷新令牌 - RefreshEmbedAuthToken

功能介绍

在access_token过期前,使用refresh_token换取新的令牌。

URI

POST /v1/app/auth/token/refresh

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

请求体类型。

约束限制:

不涉及。

取值范围:

固定值:application/x-www-form-urlencoded。

默认取值:

不涉及。

X-Cloud-Doc-AppId

是

String

参数解释:

APP ID。

约束限制:

不涉及。

取值范围:

[1-128]个字符。

默认取值:

不涉及。

表2 FormData参数

参数

是否必选

参数类型

描述

grant_type

是

String

参数解释:

授权类型。

约束限制:

不涉及。

取值范围:

refresh_token。

默认取值:

refresh_token。

refresh_token

是

String

参数解释:

刷新令牌。

约束限制:

不涉及。

取值范围:

[1-1024]个字符。

默认取值:

不涉及。

client_id

是

String

参数解释:

APP ID。

约束限制:

不涉及。

取值范围:

[1-128]个字符。

默认取值:

不涉及。

client_secret

是

String

参数解释:

APP Secret。

约束限制:

不涉及。

取值范围:

[1-256]个字符。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-Trace-Id

String

业务跟踪ID。

表4 响应Body参数

参数

参数类型

描述

access_token

String

参数解释:

获取的 access token。

取值范围:

[1-1024]个字符。

refresh_token

String

参数解释:

获取的 refresh token。

取值范围:

[1-1024]个字符。

token_type

String

参数解释:

Token类型。

取值范围:

  • Bearer。

expires_in

Long

参数解释:

access token 的有效期,单位:秒。

取值范围:

[1-86400]。

scope

String

参数解释:

授权范围。

取值范围:

[0-2048]个字符。

状态码:400

表5 响应Header参数

参数

参数类型

描述

X-Trace-Id

String

业务跟踪ID。

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表7 响应Header参数

参数

参数类型

描述

X-Trace-Id

String

业务跟踪ID。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

使用refresh_token值为aaa.bbb.ccc换取新的access_token。

https://{Endpoint}/v1/app/auth/token/refresh

{
  "grant_type" : "refresh_token",
  "refresh_token" : "aaa.bbb.ccc",
  "client_id" : "xxxxxx-yyyy-23",
  "client_secret" : "xxxxxxxxxxxxxxxxx"
}

响应示例

状态码:200

{
  "access_token" : "aaa.bbb.ccc",
  "refresh_token" : "ddd.eee.cfffcc",
  "token_type" : "Bearer",
  "expires_in" : 7200,
  "scope" : "*"
}

状态码:400

{
  "error_code" : "KPGE.00001000",
  "error_msg" : "Parameter error."
}

状态码

状态码

描述

200

请求成功。

400

错误响应。

500

错误响应。

错误码

请参见错误码。

相关文档