設置用戶SSO的身份提供商信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ram:SetUserSsoSettings | update | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MetadataDocument | string | 否 | 元數據文檔。經過 Base64 編碼。 由支持 SAML2.0 協議的身份提供商提供。 | PD94bWwgdmVy**** |
| SsoEnabled | boolean | 否 | 是否開啟 RAM 用戶的 SSO 功能。取值：
| true |
| AuxiliaryDomain | string | 否 | 輔助域名。 | example.com |
| SsoLoginWithDomain | boolean | 否 | 當用戶使用 SAML SSO 登錄時，是否要求 SAML Response 的
該參數默認取值為 | true |
返回參數
示例
正常返回示例
JSON格式
{
"UserSsoSettings": {
"AuxiliaryDomain": "example.com",
"MetadataDocument": "PD94bWwgdmVy****",
"SsoEnabled": true,
"SsoLoginWithDomain": true
},
"RequestId": "87F2E3F6-28A0-43F3-A77F-F7760E62F61E"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-09 | OpenAPI 描述信息更新、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-08-14 | OpenAPI 描述信息更新 | 查看變更詳情 |