AI 助理
备案控制台
文档
输入文档关键字查找
首页 访问控制 开发参考 API参考 API参考（STS） API目录 角色扮演 AssumeRoleWithOIDC - OIDC角色SSO时获取扮演角色的临时身份凭证

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~2048 个字符。

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

Token 有效期。单位：秒。

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

关于设置角色最大会话时间MaxSessionDuration的具体操作，请参见 CreateRole 或 UpdateRole 。

3600
RoleSessionNamestring是

角色会话名称。

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

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

长度：2~64 个字符。

TestOidcAssumedRoleSession
说明 由于 AssumeRoleWithOIDC 接口使用 OIDC Token 进行身份认证，可以匿名访问，因此不需要提供公共请求参数中的Signature、SignatureMethod、SignatureVersion和AccessKeyId参数。关于公共请求参数的详情，请参见公共请求参数。

返回参数

名称类型描述示例值
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****
ExpirationTimestring

OIDC Token 的过期时间。

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

OIDC Token 的签发时间。

2021-10-20T03:27:09Z
VerificationInfostring

OIDC Token 的检验信息。更多信息，请参见管理 OIDC 身份提供商。

Success
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****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-11API 内部配置变更，不影响调用查看变更详情
2023-09-27OpenAPI 返回结构发生变更查看变更详情
上一篇：AssumeRoleWithSAML - SAML角色SSO时获取扮演角色的临时身份凭证下一篇：调用身份
文档推荐