拉取一个有效的OAuth认证令牌。
接口说明
该 API 基于 IDaaS 签发的 Access Token 进行身份认证和鉴权。
请确保传入的 Access Token 具备访问 IDaaS 内置 PAM 应用（Privileged Access Management）的“获取认证令牌”的功能授权。
对应的 scope 为urn:cloud:idaas:pam|authentication_token:obtain。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /v2/{instanceId}/authenticationTokens/_/actions/fetchOAuthAccessToken HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Authorization |
string |
是 |
认证信息。 格式为：Bearer ${access_token}。 说明
请输入 IDaaS 签发的 Access Token。 |
Bearer xxxxxx |
| body |
object |
否 |
请求 Body。 |
|
| credentialProviderIdentifier |
string |
是 |
凭据提供商标识。 |
test_example_identifier |
| scope |
string |
否 |
对应 OAuth 协议的 scope。 说明
若不指定，则签发出的 OAuth Access Token 的 scope 范围为对应的凭据提供商处的 Scope 配置。 重要 多个 Scope 值之间会通过空格分隔。 |
example:test_01 example:test_02 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
OAuth 认证令牌详情。 |
||
| instanceId |
string |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| authenticationTokenId |
string |
认证令牌 ID。 |
atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx |
| credentialProviderId |
string |
凭据提供商 ID。 |
atp_01kr2cmj5gxxx4fvmls2e93dxxxxx |
| createTime |
integer |
认证令牌的创建时间，Unix 时间戳，单位毫秒。 |
1649830225000 |
| updateTime |
integer |
认证令牌的更新时间，Unix 时间戳，单位毫秒。 |
1649830225000 |
| authenticationTokenType |
string |
认证令牌类型。 说明
取值固定为 |
oauth_access_token |
| revoked |
boolean |
认证令牌是否被吊销。 |
false |
| creatorType |
string |
认证令牌创建者类型。取值可选范围：
|
application |
| creatorId |
string |
认证令牌创建者 ID。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx |
| consumerType |
string |
认证令牌使用者类型。取值可选范围：
|
application |
| consumerId |
string |
认证令牌使用者 ID。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx |
| expirationTime |
integer |
认证令牌过期时间，Unix 时间戳，单位毫秒。 |
1772693568000 |
| oauthAccessTokenContent |
object |
OAuth Access Token 类型认证令牌内容。 |
|
| accessTokenValue |
string |
对应 OAuth 协议中的 Token 端点响应的 access_token 字段。 |
DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| tokenType |
string |
对应 OAuth 协议中的 Token 端点响应的 token_type 字段。 |
Bearer |
| scope |
string |
对应 OAuth 协议中的 Token 端点响应的 scope 字段。 |
example:test_01 example:test_02 |
示例
正常返回示例
JSON格式
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
"credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
"createTime": 1649830225000,
"updateTime": 1649830225000,
"authenticationTokenType": "oauth_access_token",
"revoked": false,
"creatorType": "application",
"creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"consumerType": "application",
"consumerId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"expirationTime": 1772693568000,
"oauthAccessTokenContent": {
"accessTokenValue": "DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"tokenType": "Bearer",
"scope": "example:test_01 example:test_02"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。