調用SetExternalSAMLIdentityProvider配置SAML身份提供商（IdP）信息。
接口說明
在基于 SAML 2.0 的 SSO 登錄過程中，云 SSO 目錄是服務提供商（SP），而企業自有的身份管理系統則是身份提供商（IdP）。
配置 SAML 身份提供商（IdP）信息有以下兩種方式，您可以任選其一進行配置，但不能同時進行配置。需要用到的元數據文檔或相關參數，請從您的 IdP 中獲取。
- 元數據文檔：通過
EncodedMetadataDocument參數配置元數據文檔。 - 手動配置：通過
EntityId、LoginUrl、WantRequestSigned和X509Certificate參數手動配置 IdP 信息。
如果已經配置過 SAML IdP 信息，則調用本 API 會替換已有的配置信息。具體如下：
- 元數據文檔：全部替換為新的配置信息。
- 手動配置：只替換提供的新參數值。
說明
如果 SSO 登錄狀態是已啟用，替換后的配置信息會立即生效，請注意對生產環境的影響。
本文將提供一個示例，在目錄d-00fc2p61****下通過元數據文檔配置 IdP 信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cloudsso:SetExternalSAMLIdentityProvider | update | *Directory acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DirectoryId | string | 是 | 目錄 ID。 | d-00fc2p61**** |
| EncodedMetadataDocument | string | 否 | IdP 元數據文檔（Base64 編碼）。 由支持 SAML 2.0 協議的 IdP 提供。 | PD94bWwgdmVyc2lvbj0iMS4**** |
| SSOStatus | string | 否 | SSO 登錄的啟用狀態。取值：
| Disabled |
| EntityId | string | 否 | IdP 標識。 | http://www.okta.com/exk3qwgtjhetR2Od**** |
| LoginUrl | string | 否 | IdP 的登錄地址。 | https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml |
| WantRequestSigned | boolean | 否 | 在用戶訪問云 SSO 登錄頁面發起 SAML SSO 時，是否要求云 SSO 發送簽名的 SAML 請求。取值：
| false |
| X509Certificate | string | 否 | PEM 格式的 X509 證書。指定該參數會替換所有已經存在的證書。 | MIIC8DCCAdigAwIBAgIQP9eomUYGeoND**** |
| BindingType | string | 否 | 發起 SAML 請求的 Binding 方式。取值：
| Redirect |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "63160579-2E1B-57B0-8273-B27427172385",
"SAMLIdentityProviderConfiguration": {
"EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
"SSOStatus": "Disabled",
"DirectoryId": "d-00fc2p61****",
"EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
"CreateTime": "2021-11-10T02:57:16Z",
"WantRequestSigned": false,
"UpdateTime": "2021-11-10T02:57:16Z",
"CertificateIds": [
"[ \"idp-c-00buzdx63z8ewtdf****\", \"idp-c-00gmuxnr2mrek3t2****\" ]"
],
"LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
"BindingType": "Redirect"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-21 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |