接口请求域名: sts.intl.tencentcloudapi.com 。
申请OIDC角色临时访问凭证。
注意:当使用签名方法 V3 调用本接口时,请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。
默认接口请求频率限制:80次/秒。
注意:当使用签名方法 V3 调用本接口时,请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AssumeRoleWithWebIdentity。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ProviderId | 是 | String | 身份提供商名称 |
| WebIdentityToken | 是 | String | IdP签发的OIDC令牌 |
| RoleArn | 是 | String | 角色访问描述名 |
| RoleSessionName | 是 | String | 会话名称 |
| DurationSeconds | 否 | Integer | 指定临时访问凭证的有效期,单位:秒,默认 7200 秒,最长可设定有效期为 43200 秒 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ExpiredTime | Integer | 临时访问凭证过期时间(时间戳) |
| Expiration | String | 临时访问凭证过期时间 |
| Credentials | Credentials | 临时访问凭证 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
申请OIDC角色临时访问凭证
POST / HTTP/1.1
Host: sts.intl.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 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.GetRoleError | 获取角色失败。 |
| InternalError.SystemError | 系统内部错误,如网络错误。 |
| InternalError.UnknownError | 未知错误。 |
| InvalidParameter.OverLimit | 超过频率限制。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameter.WebIdentityTokenError | WebIdentityToken参数错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| UnauthorizedOperation | 未授权操作。 |
文档反馈