AssumeRoleWithOIDC - OIDC角色SSO时获取扮演角色的临时身份凭证

进行OIDC角色SSO时,通过调用AssumeRoleWithOIDC接口,获取扮演RAM角色的临时身份凭证(STS Token)。

接口说明

前提条件

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
OIDCProviderArnstring

OIDC身份提供商的ARN。

您可以通过RAM控制台或API查看OIDC身份提供商的ARN。具体如下:

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

需要扮演的RAM角色ARN。

您可以通过RAM控制台或API查看角色ARN。具体如下:

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

由外部IdP签发的OIDC令牌(OIDC Token)。

长度:4~20000个字符。

说明需要输入原始OIDC Token,无需Base64解码。
eyJraWQiOiJKQzl3eHpyaHFKMGd0****
Policystring

为STS Token额外添加的一个权限策略,进一步限制STS Token的权限。具体如下:

  • 如果指定该权限策略,则STS Token最终的权限取RAM角色权限策略与该权限策略的交集。
  • 如果不指定该权限策略,则STS Token最终的权限就是RAM角色的权限。

长度:1~1024个字符。

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

Token有效期。单位:秒。

默认值:3600。最小值:900。最大值:MaxSessionDuration设置的时间。

关于设置角色最大会话时间MaxSessionDuration的具体操作,请参见CreateRoleUpdateRole

3600
RoleSessionNamestring

角色会话名称。

该参数为用户自定义参数。通常设置为调用该API的用户身份,例如:用户名。在操作审计日志中,即使是同一个RAM角色执行的操作,也可以根据不同的RoleSessionName来区分实际操作者,以实现用户级别的访问审计。

格式:包含英文字母、数字、半角句号(.)、at(@)、短划线(-)和下划线(_)。

长度:2~64个字符。

TestOidcAssumedRoleSession
说明由于AssumeRoleWithOIDC接口使用OIDC Token进行身份认证,可以匿名访问,因此不需要提供公共参数中的SignatureSignatureMethodSignatureVersionAccessKeyId参数。

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求ID。

3D57EAD2-8723-1F26-B69C-F8707D8B565D
OIDCTokenInfoobject

解析的OIDC Token信息。

Subjectstring

OIDC主体。

对应OIDC Token中的sub字段值。

KryrkIdjylZb7agUgCEf****
Issuerstring

OIDC颁发者URL。

对应OIDC Token中的iss字段值。

https://dev-xxxxxx.okta.com
ClientIdsstring

OIDC受众。多个之间用半角逗号(,)分隔。

对应OIDC Token中的aud字段值。

496271242565057****
AssumedRoleUserobject

角色扮演临时身份。

AssumedRoleIdstring

临时身份的ID。

33157794895460****
Arnstring

临时身份的ARN。

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

临时访问凭证(STS Token)。

SecurityTokenstring

安全令牌。

CAIShwJ1q6Ft5B2yfSjIr5bSEsj4g7BihPWGWHz****
Expirationstring

Token到期失效时间(UTC时间)。

2021-10-20T04:27:09Z
AccessKeySecretstring

访问密钥。

CVwjCkNzTMupZ8NbTCxCBRq3K16jtcWFTJAyBEv2****
AccessKeyIdstring

访问密钥ID。

STS.NUgYrLnoC37mZZCNnAbez****

示例

请求示例

https://sts.aliyuncs.com/?Action=AssumeRoleWithOIDC
&OIDCProviderArn=acs:ram::113511544585****:oidc-provider/TestOidcIdp
&RoleArn=acs:ram::113511544585****:role/testoidc
&OIDCToken=eyJraWQiOiJKQzl3eHpyaHFKMGd0****
&Policy={"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
&DurationSeconds=3600
&RoleSessionName=TestOidcAssumedRoleSession
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "3D57EAD2-8723-1F26-B69C-F8707D8B565D",
    "OIDCTokenInfo": {
        "Subject": "KryrkIdjylZb7agUgCEf****",
        "Issuer": "https://dev-xxxxxx.okta.com",
        "ClientIds": "496271242565057****"
    },
    "AssumedRoleUser": {
        "AssumedRoleId": "33157794895460****",
        "Arn": "acs:ram::113511544585****:role/testoidc/TestOidcAssumedRoleSession"
    },
    "Credentials": {
        "SecurityToken": "CAIShwJ1q6Ft5B2yfSjIr5bSEsj4g7BihPWGWHz****",
        "Expiration": "2021-10-20T04:27:09Z",
        "AccessKeySecret": "CVwjCkNzTMupZ8NbTCxCBRq3K16jtcWFTJAyBEv2****",
        "AccessKeyId": "STS.NUgYrLnoC37mZZCNnAbez****"
    }
}

XML格式

<?xml version="1.0" encoding="UTF-8" ?>
<AssumeRoleWithOIDCResponse>
	<RequestId>3D57EAD2-8723-1F26-B69C-F8707D8B565D</RequestId>
	<OIDCTokenInfo>
		<Subject>KryrkIdjylZb7agUgCEf****</Subject>
		<Issuer>https://dev-xxxxxx.okta.com</Issuer>
		<ClientIds>496271242565057****</ClientIds>
	</OIDCTokenInfo>
	<AssumedRoleUser>
		<AssumedRoleId>33157794895460****</AssumedRoleId>
		<Arn>acs:ram::113511544585****:role/testoidc/TestOidcAssumedRoleSession</Arn>
	</AssumedRoleUser>
	<Credentials>
		<SecurityToken>CAIShwJ1q6Ft5B2yfSjIr5bSEsj4g7BihPWGWHz****</SecurityToken>
		<Expiration>2021-10-20T04:27:09Z</Expiration>
		<AccessKeySecret>CVwjCkNzTMupZ8NbTCxCBRq3K16jtcWFTJAyBEv2****</AccessKeySecret>
		<AccessKeyId>STS.NUgYrLnoC37mZZCNnAbez****</AccessKeyId>
	</Credentials>
</AssumeRoleWithOIDCResponse>	

错误码

访问错误中心查看更多错误码。

阿里云首页 访问控制 相关技术圈