Domain name for API request: sts.tencentcloudapi.com.
This API is used to apply for an OIDC role credential.
A maximum of 20 requests can be initiated per second for this API.
Note: when called with signature method v3, this API doesn't require Authorization
and X-TC-Token
request header.
Note: when called with signature method v1, this API doesn't require SecretId
, Signature
, SignatureMethod
and Token
parameters.
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 | The validity period of the temporary credential in seconds. Default value: 7,200s. Maximum value: 43,200s. |
Parameter Name | Type | Description |
---|---|---|
ExpiredTime | Integer | Expiration time of the temporary credential (timestamp) |
Expiration | String | Expiration time of the temporary credential |
Credentials | Credentials | Temporary credential |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: sts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssumeRoleWithWebIdentity
<Common request parameters>
{
"DurationSeconds": "5000",
"RoleSessionName": "test_OIDC",
"WebIdentityToken": "eyJraWQiOiJkT**********CNOQ",
"RoleArn": "qcs::cam::uin/798950673:roleName/OneLogin-Role",
"ProviderId": "OIDC"
}
{
"Response": {
"ExpiredTime": 1543914376,
"Expiration": "2018-12-04T09:06:16Z",
"Credentials": {
"Token": "1siMD5r0tPAq9xpR******6a1ad76f09a0069002923def8aFw7tUMd2nH",
"TmpSecretId": "AKID65zyIP0mp****qt2SlWIQVMn1umNH58",
"TmpSecretKey": "q95K84wrzuE****y39zg52boxvp71yoh"
},
"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.ParamError | Invalid parameter. |
InvalidParameter.WebIdentityTokenError | WebIdentityToken parameter error |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?