安全凭证服务 申请OIDC角色临时访问凭证

接口请求域名: sts.tencentcloudapi.com 。推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。可以查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

相关产品
安全凭证服务 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

申请OIDC角色临时访问凭证。

注意:当使用签名方法 V3 调用本接口时,请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。

默认接口请求频率限制:80次/秒。

注意:当使用签名方法 V3 调用本接口时,请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:AssumeRoleWithWebIdentity。
Version 是 String 公共参数,本接口取值:2018-08-13。
Region 是 String 公共参数,详见产品支持的 地域列表。
ProviderId 是 String 身份提供商名称示例值:OIDC
WebIdentityToken 是 String IdP签发的OIDC令牌示例值:eyJraWQiOiJkT**CNOQ
RoleArn 是 String 角色访问描述名示例值:qcs::cam::uin/7989***:roleName/OneLogin-Role
RoleSessionName 是 String 会话名称示例值:test_OIDC
DurationSeconds 否 Integer 指定临时访问凭证的有效期,单位:秒,默认 7200 秒,最长可设定有效期为 43200 秒示例值:3600

三、3. 输出参数

参数名称 类型 描述
ExpiredTime Integer 临时访问凭证过期时间(时间戳)示例值:1543914376
Expiration String 临时访问凭证过期时间示例值:2018-12-04T09:06:16Z
Credentials Credentials 临时访问凭证示例值:{"Token":"1siMD*","TmpSecretId":"AKID*","TmpSecretKey":"q95K***"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、示例1 申请OIDC角色临时访问凭证

申请OIDC角色临时访问凭证

五、输入示例

POST / HTTP/1.1
Host: sts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssumeRoleWithWebIdentity
<公共请求参数>
{
"DurationSeconds": "1800",
"RoleSessionName": "test_OIDC",
"WebIdentityToken": "eyJraWQiOiJkT**********CNOQ",
"RoleArn": "qcs::cam::uin/7989***:roleName/OneLogin-Role",
"ProviderId": "OIDC"
}

六、输出示例

{
"Response": {
"ExpiredTime": 1543914376,
"Expiration": "2018-12-04T09:06:16Z",
"Credentials": {
"Token": "1siMD***",
"TmpSecretId": "AKID***",
"TmpSecretKey": "q95K***"
},
"RequestId": "f6e7cbcb-add1-47bd-9097-d08cf8f3a919"
}
}

七、腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。

八、API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

九、SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十、命令行工具

·Tencent Cloud CLI 3.0

十一、6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InternalError.GetRoleError 获取角色失败。
InternalError.SystemError 系统内部错误,如网络错误。
InternalError.UnknownError 未知错误。
InvalidParameter.OverLimit 超过频率限制。
InvalidParameter.ParamError 参数错误。
InvalidParameter.WebIdentityTokenError WebIdentityToken参数错误。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
赞 (0)
上一篇 4天前
下一篇 4天前