Domain name for API request: sts.intl.tencentcloudapi.com.
This API is used to apply for an OIDC role credential.
Note: When called with signature method v3, header X-TC-Token could be ignored, and Authorization should be SKIP.
A maximum of 80 requests can be initiated per second for this API.
Note: when called with signature method v3, header X-TC-Token could be ignored, and Authorization should be SKIP.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: AssumeRoleWithWebIdentity. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-13. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProviderId | Yes | String | Identity provider name |
| WebIdentityToken | Yes | String | OIDC token issued by the IdP |
| RoleArn | Yes | String | Role access description name |
| RoleSessionName | Yes | String | Session name |
| DurationSeconds | No | Integer | Specifies the validity period of the temporary access credentials in seconds. Default value: 7,200s. Maximum value: 43,200s. |
| Parameter Name | Type | Description |
|---|---|---|
| ExpiredTime | Integer | Expiration time of the temporary access credentials (timestamp). |
| Expiration | String | Expiration time of the temporary access credentials. |
| Credentials | Credentials | Temporary access credentials |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to apply for temporary credentials for an OIDC role.
POST / HTTP/1.1
Host: sts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssumeRoleWithWebIdentity
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.GetRoleError | Failed to get the role. |
| InternalError.SystemError | Internal system error, such as network error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameter.OverLimit | Frequency limit exceeded. |
| InvalidParameter.ParamError | Invalid parameter. |
| InvalidParameter.WebIdentityTokenError | WebIdentityToken parameter error |
| RequestLimitExceeded | Too many and frequent requests. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック