调用GenerateToken接口,生成指定实例下的访问应用的access token。
接口说明
说明
目前支持的方式:授权码模式、设备流、刷新 token、客户端模式
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /v2/{instanceId}/{applicationId}/oauth2/token
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
applicationId | string | 是 | 应用 ID。 | app_mkv7rgt4d7i4u7zqtzev2mxxxx |
client_id | string | 否 | 客户端 ID。 | app_mkv7rgt4d7i4u7zqtzev2mxxxx |
client_secret | string | 否 | 客户端密钥,赋值场景: 当 grant_type 为 client_credentials",采用 client_secret_post 方式时,需填写此值。 | CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx |
grant_type | string | 是 | 授权类型,目前支持的类型如下:
| client_credentials |
code | string | 否 | 授权 code 码,传入场景: grant_type=authorization_code 授权码模式时,必须参数 | xxxx |
username | string | 否 | 账户名,在帐密模式下,必须传入,暂不支持 | uesrname_001 |
password | string | 否 | 账户名,在帐密模式下,必须传入,暂不支持 | xxxxxx |
device_code | string | 否 | 设备 code 码,传入场景: grant_type=urn:ietf:params:oauth:grant-type:device_code 即设备流模式时,必须参数 | xxxx |
redirect_uri | string | 否 | 重定向 URI,传入场景: grant_type=authorization_code 授权码模式时,必须参数,与获取授权码请求中的重定向 URI 必须是一致的 | xxx |
refresh_token | string | 否 | 刷新 token,传入场景: grant_type=refresh_token 即刷新令牌模式时,必须参数 | ATxxx |
code_verifier | string | 否 | 验证 code | xxx |
exclusive_tag | string | 否 | 排除的 tag | ATxxx |
scope | string | 否 | scope 范围, 非必须,可选的值
| xxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"token_type": "Bearer",
"access_token": "ATxxx",
"refresh_token": "RTxxx",
"expires_in": 1200,
"expires_at": 1653288641,
"id_token": "xxxxx"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2023-10-24 | API 内部配置变更,不影响调用 | 看变更集 | ||
| ||||
2023-04-04 | API 内部配置变更,不影响调用 | 看变更集 | ||
|