com.aliyun.sts20150401.models

类 AssumeRoleWithOIDCRequest

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.sts20150401.models.AssumeRoleWithOIDCRequest

public class AssumeRoleWithOIDCRequest
extends com.aliyun.tea.TeaModel

字段概要

字段

限定符和类型	字段和说明
Long	durationSeconds The validity period of the STS token.
String	OIDCProviderArn The Alibaba Cloud Resource Name (ARN) of the OIDC IdP.
String	OIDCToken The OIDC token that is issued by the external IdP.
String	policy The policy that specifies the permissions of the returned STS token.
String	roleArn The ARN of the RAM role.
String	roleSessionName The custom name of the role session.

构造器概要

构造器

构造器和说明
AssumeRoleWithOIDCRequest()

方法概要

限定符和类型	方法和说明
static AssumeRoleWithOIDCRequest	build(Map<String,?> map)
Long	getDurationSeconds()
String	getOIDCProviderArn()
String	getOIDCToken()
String	getPolicy()
String	getRoleArn()
String	getRoleSessionName()
AssumeRoleWithOIDCRequest	setDurationSeconds(Long durationSeconds)
AssumeRoleWithOIDCRequest	setOIDCProviderArn(String OIDCProviderArn)
AssumeRoleWithOIDCRequest	setOIDCToken(String OIDCToken)
AssumeRoleWithOIDCRequest	setPolicy(String policy)
AssumeRoleWithOIDCRequest	setRoleArn(String roleArn)
AssumeRoleWithOIDCRequest	setRoleSessionName(String roleSessionName)

从类继承的方法 com.aliyun.tea.TeaModel

build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object

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

字段详细资料

durationSeconds

@NameInMap(value="DurationSeconds")
public Long durationSeconds

The validity period of the STS token. Unit: seconds.

Default value: 3600. Minimum value: 900. Maximum value: the value of the MaxSessionDuration parameter.

For more information about how to specify MaxSessionDuration, see CreateRole or UpdateRole.

example:

3600

OIDCProviderArn

@NameInMap(value="OIDCProviderArn")
public String OIDCProviderArn

The Alibaba Cloud Resource Name (ARN) of the OIDC IdP.

You can view the ARN in the RAM console or by calling operations.

• For more information about how to view the ARN in the RAM console, see View the information about an OIDC IdP.
• For more information about how to view the ARN by calling operations, see GetOIDCProvider or ListOIDCProviders.

example:

acs:ram::113511544585****:oidc-provider/TestOidcIdp

OIDCToken

@NameInMap(value="OIDCToken")
public String OIDCToken

The OIDC token that is issued by the external IdP.

The OIDC token must be 4 to 20,000 characters in length.

You must enter the original OIDC token. You do not need to enter the Base64-encoded OIDC token.

example:

eyJraWQiOiJKQzl3eHpyaHFKMGd0****

policy

@NameInMap(value="Policy")
public String policy

The policy that specifies the permissions of the returned STS token. You can use this parameter to grant the STS token fewer permissions than the permissions granted to the RAM role.

• If you specify this parameter, the permissions of the returned STS token are the permissions that are included in the value of this parameter and owned by the RAM role.
• If you do not specify this parameter, the returned STS token has all the permissions of the RAM role.

The value must be 1 to 2,048 characters in length.

example:

{"Statement": [{"Action": [""],"Effect": "Allow","Resource": [""]}],"Version":"1"}

roleArn

@NameInMap(value="RoleArn")
public String roleArn

The ARN of the RAM role.

You can view the ARN in the RAM console or by calling operations.

• For more information about how to view the ARN in the RAM console, see How do I view the ARN of the RAM role?
• For more information about how to view the ARN by calling operations, see ListRoles or GetRole.

example:

acs:ram::113511544585****:role/testoidc

roleSessionName

@NameInMap(value="RoleSessionName")
public String roleSessionName

The custom name of the role session.

Set this parameter based on your business requirements. In most cases, this parameter is set to the identity of the user who calls the operation, for example, the username. In ActionTrail logs, you can distinguish the users who assume the same RAM role to perform operations based on the value of the RoleSessionName parameter. This way, you can perform user-specific auditing.

The value can contain letters, digits, periods (.), at signs (@), hyphens (-), and underscores (_).

The value must be 2 to 64 characters in length.

example:

TestOidcAssumedRoleSession

构造器详细资料

AssumeRoleWithOIDCRequest

public AssumeRoleWithOIDCRequest()

方法详细资料

build

public static AssumeRoleWithOIDCRequest build(Map<String,?> map)
                                       throws Exception

抛出:

Exception

setDurationSeconds

public AssumeRoleWithOIDCRequest setDurationSeconds(Long durationSeconds)

getDurationSeconds

public Long getDurationSeconds()

setOIDCProviderArn

public AssumeRoleWithOIDCRequest setOIDCProviderArn(String OIDCProviderArn)

getOIDCProviderArn

public String getOIDCProviderArn()

setOIDCToken

public AssumeRoleWithOIDCRequest setOIDCToken(String OIDCToken)

getOIDCToken

public String getOIDCToken()

setPolicy

public AssumeRoleWithOIDCRequest setPolicy(String policy)

getPolicy

public String getPolicy()

setRoleArn

public AssumeRoleWithOIDCRequest setRoleArn(String roleArn)

getRoleArn

public String getRoleArn()

setRoleSessionName

public AssumeRoleWithOIDCRequest setRoleSessionName(String roleSessionName)

getRoleSessionName

public String getRoleSessionName()