調用SetUserSsoSettings介面配置使用者SSO-存取控制-阿里雲 - Resource Access Management

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ram:SetUserSsoSettings

update

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
MetadataDocument	string	否	中繼資料文檔。經過 Base 64 編碼。由支援 SAML2.0 協議的身份供應商提供。	PD94bWwgdmVy****
SsoEnabled	boolean	否	是否開啟 RAM 使用者的 SSO 功能。取值： true：開啟。 false（預設值）：關閉。	true
AuxiliaryDomain	string	否	輔助網域名稱。	example.com
SsoLoginWithDomain	boolean	否	當使用者使用 SAML SSO 登入時，是否要求 SAML Response 的`<saml:NameID>`元素內容中包含網域名稱（即在 IdP 側指定的用於 SSO 登入匹配的使用者名稱是否帶有網域名稱尾碼）。該參數取值為`true`時，`<saml:NameID>`元素內容必須形如`username@domain`（即帶有網域名稱尾碼），其中`domain`可以是預設的網域名稱，也可以是域別名（若已設定）。該參數取值為`false`時，`<saml:NameID>`元素內容應當僅有`username`部分（即不帶有網域名稱尾碼），不得帶有`domain`部分。該參數預設取值為`true`。	true
AuthnSignAlgo	string	否	阿里雲 SP 支援的簽名演算法。取值： rsa-sha256 rsa-sha1（預設值）	rsa-sha1

返回參數

名稱	類型	描述	樣本值
	object
UserSsoSettings	object	使用者 SSO 配置資訊。
AuxiliaryDomain	string	輔助網域名稱。	example.com
MetadataDocument	string	中繼資料文檔。經過 Base 64 編碼。	PD94bWwgdmVy****
SsoEnabled	boolean	是否開啟使用者 SSO。	true
SsoLoginWithDomain	boolean	當使用者使用 SAML SSO 登入時，是否要求 SAML Response 的`<saml:NameID>`元素內容中包含網域名稱（即在 IdP 側指定的用於 SSO 登入匹配的使用者名稱是否帶有網域名稱尾碼）。該參數取值為`true`時，`<saml:NameID>`元素內容必須形如`username@domain`（即帶有網域名稱尾碼），其中`domain`可以是預設的網域名稱，也可以是域別名（若已設定）。該參數取值為`false`時，`<saml:NameID>`元素內容應當僅有`username`部分（即不帶有網域名稱尾碼），不得帶有`domain`部分。該參數預設取值為`true`。	true
AuthnSignAlgo	string	阿里雲 SP 支援的簽名演算法。取值： rsa-sha256 rsa-sha1（預設值）	rsa-sha1
RequestId	string	請求 ID。	87F2E3F6-28A0-43F3-A77F-F7760E62F61E

樣本

正常返回樣本

JSON格式

{
  "UserSsoSettings": {
    "AuxiliaryDomain": "example.com",
    "MetadataDocument": "PD94bWwgdmVy****",
    "SsoEnabled": true,
    "SsoLoginWithDomain": true,
    "AuthnSignAlgo": "rsa-sha1"
  },
  "RequestId": "87F2E3F6-28A0-43F3-A77F-F7760E62F61E"
}

錯誤碼

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

變更歷史

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