Package com.tencentcloudapi.sts.v20180813

Class StsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.sts.v20180813.StsClient

public class StsClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor	Description
StsClient(Credential credential, String region)
StsClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method	Description
AssumeRoleResponse	AssumeRole(AssumeRoleRequest req)	申请扮演角色临时访问凭证。
AssumeRoleWithSAMLResponse	AssumeRoleWithSAML(AssumeRoleWithSAMLRequest req)	本接口（AssumeRoleWithSAML）用于根据 SAML 断言申请角色临时访问凭证。 注意：当使用签名方法 V3 调用本接口时，请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。
AssumeRoleWithWebIdentityResponse	AssumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest req)	申请OIDC角色临时访问凭证。 注意：当使用签名方法 V3 调用本接口时，请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。
GetCallerIdentityResponse	GetCallerIdentity(GetCallerIdentityRequest req)	获取当前调用者的身份信息。 接口支持主账号，子账号长期密钥以及AssumeRole，GetFederationToken生成的临时访问凭证身份获取。
GetFederationTokenResponse	GetFederationToken(GetFederationTokenRequest req)	使用说明** 返回一组临时访问凭证，典型的应用场景是代理应用程序集中申请临时访问凭证，下发给企业网络内其他分布式终端应用，比如终端应用上传文件到COS场景，本接口仅支持永久密钥调用。 最佳实践** 1.
QueryApiKeyResponse	QueryApiKey(QueryApiKeyRequest req)	拉取API密钥列表

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StsClient

public StsClient(Credential credential,
                 String region)

StsClient

public StsClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

AssumeRole

public AssumeRoleResponse AssumeRole(AssumeRoleRequest req)
                              throws TencentCloudSDKException

申请扮演角色临时访问凭证。

Parameters:

req - AssumeRoleRequest

Returns:

AssumeRoleResponse

Throws:

TencentCloudSDKException

AssumeRoleWithSAML

public AssumeRoleWithSAMLResponse AssumeRoleWithSAML(AssumeRoleWithSAMLRequest req)
                                              throws TencentCloudSDKException

本接口（AssumeRoleWithSAML）用于根据 SAML 断言申请角色临时访问凭证。 注意：当使用签名方法 V3 调用本接口时，请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。

Parameters:

req - AssumeRoleWithSAMLRequest

Returns:

AssumeRoleWithSAMLResponse

Throws:

TencentCloudSDKException

AssumeRoleWithWebIdentity

public AssumeRoleWithWebIdentityResponse AssumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest req)
                                                            throws TencentCloudSDKException

申请OIDC角色临时访问凭证。 注意：当使用签名方法 V3 调用本接口时，请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。

Parameters:

req - AssumeRoleWithWebIdentityRequest

Returns:

AssumeRoleWithWebIdentityResponse

Throws:

TencentCloudSDKException

GetCallerIdentity

public GetCallerIdentityResponse GetCallerIdentity(GetCallerIdentityRequest req)
                                            throws TencentCloudSDKException

获取当前调用者的身份信息。 接口支持主账号，子账号长期密钥以及AssumeRole，GetFederationToken生成的临时访问凭证身份获取。

Parameters:

req - GetCallerIdentityRequest

Returns:

GetCallerIdentityResponse

Throws:

TencentCloudSDKException

GetFederationToken

public GetFederationTokenResponse GetFederationToken(GetFederationTokenRequest req)
                                              throws TencentCloudSDKException

使用说明** 返回一组临时访问凭证，典型的应用场景是代理应用程序集中申请临时访问凭证，下发给企业网络内其他分布式终端应用，比如终端应用上传文件到COS场景，本接口仅支持永久密钥调用。 最佳实践** 1. 临时访问凭据在有效期内都可以使用，建议在有效期内重复使用，以避免业务请求速率上升后被限频 2. 授予临时访问凭证权限的CAM策略，建议按权限最小化原则 3. 调用接口的永久密钥，建议不要使用主账号

Parameters:

req - GetFederationTokenRequest

Returns:

GetFederationTokenResponse

Throws:

TencentCloudSDKException

QueryApiKey

public QueryApiKeyResponse QueryApiKey(QueryApiKeyRequest req)
                                throws TencentCloudSDKException

拉取API密钥列表

Parameters:

req - QueryApiKeyRequest

Returns:

QueryApiKeyResponse

Throws:

TencentCloudSDKException