全部產品
Search
文件中心

Resource Access Management:AssumeRoleWithSAML

更新時間:Oct 26, 2026

進行SAML角色SSO時,透過呼叫AssumeRoleWithSAML介面,取得扮演RAM角色的臨時身分憑證(STS Token)。

介面說明

前提條件

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

SAMLProviderArn

string

否

RAM 中建立的 SAML 身分提供者的 ARN。

格式:acs:ram::<account_id>:saml-provider/<saml_provider_id>。

您可以透過 RAM 主控台或 API 檢視身分提供者的 ARN。具體如下:

acs:ram::123456789012****:saml-provider/company1

RoleArn

string

否

要扮演的 RAM 角色的 ARN。

該角色是可信實體為 SAML 身分提供者的 RAM 角色。更多資訊,請參閱建立可信實體為身分提供者的 RAM 角色或 CreateRole 。

格式:acs:ram::<account_id>:role/<role_name>。

您可以透過 RAM 主控台或 API 檢視角色 ARN。具體如下:

acs:ram::123456789012****:role/adminrole

SAMLAssertion

string

否

Base64 編碼後的 SAML 斷言。

長度為 4~100000 個字元。

說明

需要從 IdP 取得完整的 SAML 回應,不能是單獨的 SAML 斷言欄位。

base64_encoded_saml_assertion

Policy

string

否

為 STS Token 額外新增的一個權限原則,進一步限制 STS Token 的權限。具體如下:

  • 如果指定該權限原則,則 STS Token 最終的權限取 RAM 角色權限原則與該權限原則的交集。

  • 如果不指定該權限原則,則 STS Token 最終的權限就是 RAM 角色的權限。

長度為 1~2048 個字元。

url_encoded_policy

DurationSeconds

integer

否

Token 有效期。單位:秒。

Token 有效期最小值為 900 秒,最大值為MaxSessionDuration設定的時間,預設值為 3600 秒。

您可以透過 CreateRole 或 UpdateRole 介面設定角色最大工作階段時間MaxSessionDuration。更多資訊,請參閱 CreateRole 或 UpdateRole 。

3600

說明

由於 AssumeRoleWithSAML 介面使用 SAML 斷言進行身分驗證,可以匿名存取,因此不需要提供公用請求參數中的Signature、SignatureMethod、SignatureVersion和AccessKeyId參數。關於公用請求參數的詳細資訊,請參閱公用請求參數。

返回參數

名稱

類型

描述

樣本值

object

傳回參數。

RequestId

string

請求 ID。

6894B13B-6D71-4EF5-88FA-F32781734A7F

SAMLAssertionInfo

object

SAML 斷言中的部分資訊。

SubjectType

string

SAML 斷言中NameID的格式。當首碼為urn:oasis:names:tc:SAML:2.0:nameid-format:時,首碼會被移除。例如:persistent/transient。

persistent

Subject

string

SAML 斷言中Subject - NameID欄位的值。

alice@example.com

Issuer

string

SAML 斷言中Issuer欄位的值。

http://example.com/adfs/services/trust

Recipient

string

SAML 斷言中Subject - SubjectConfirmation - SubjectConfirmationData欄位中Recipient屬性的值。

https://signin.alibabacloud.com/saml-role/SSO

AssumedRoleUser

object

角色扮演臨時身分。

AssumedRoleId

string

臨時身分的 ID。

34458433936495****:alice

Arn

string

臨時身分的 ARN。

acs:sts::123456789012****:assumed-role/AdminRole/alice

Credentials

object

存取憑證。

SecurityToken

string

安全權杖。

說明

安全權杖的長度不固定,我們強烈建議您不要對安全權杖的最大長度做任何限制。

********

Expiration

string

Token 到期失效時間(UTC 時間)。

2015-04-09T11:52:19Z

AccessKeySecret

string

存取金鑰。

wyLTSmsyPGP1ohvvw8xYgB29dlGI8KMiH2pK****

AccessKeyId

string

存取金鑰 ID。

STS.L4aBSCSJVMuKg5U1****

SourceIdentity

string

來源身分資訊。

在扮演角色時,可以指定扮演者的來源身分(SourceIdentity)作為工作階段的初始身分識別碼。 該來源身分的值在持續扮演角色的鏈式工作階段中將一直存在,中途不可變更,可確保操作的可追溯性和安全性。

如果沒有設定來源身分資訊,則該欄位不會傳回。

Alice

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6894B13B-6D71-4EF5-88FA-F32781734A7F",
  "SAMLAssertionInfo": {
    "SubjectType": "persistent",
    "Subject": "alice@example.com",
    "Issuer": "http://example.com/adfs/services/trust",
    "Recipient": "https://signin.alibabacloud.com/saml-role/SSO"
  },
  "AssumedRoleUser": {
    "AssumedRoleId": "34458433936495****:alice",
    "Arn": "acs:sts::123456789012****:assumed-role/AdminRole/alice"
  },
  "Credentials": {
    "SecurityToken": "********",
    "Expiration": "2015-04-09T11:52:19Z",
    "AccessKeySecret": "wyLTSmsyPGP1ohvvw8xYgB29dlGI8KMiH2pK****",
    "AccessKeyId": "STS.L4aBSCSJVMuKg5U1****"
  },
  "SourceIdentity": "Alice"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

500 InternalError STS Server Internal Error happened, please send the RequestId to us. 發生內部錯誤。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。