調用SetExternalSAMLIdentityProvider配置SAML身份供應商資訊-雲SSO-阿里雲

調用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 中繼資料文檔（Base 64 編碼）。由支援 SAML 2.0 協議的 IdP 提供。	PD94bWwgdmVyc2lvbj0iMS4****
SSOStatus	string	否	SSO 登入的啟用狀態。取值： Enabled：啟用。 Disabled（預設值）：禁用。	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 請求。取值： true：要求雲 SSO 發送簽名的 SAML 請求。 false（預設值）：不要求雲 SSO 發送簽名的 SAML 請求。	false
X509Certificate	string	否	PEM 格式的 X509 認證。指定該參數會替換所有已經存在的認證。	MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****
BindingType	string	否	發起 SAML 請求的 Binding 方式。取值： Post：以 Post 的方式發起 SAML 請求。 Redirect：以 Redirect 的方式發起 SAML 請求。	Redirect

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	63160579-2E1B-57B0-8273-B27427172385
SAMLIdentityProviderConfiguration	object	IdP 配置資訊。
EntityId	string	IdP 標識。	http://www.okta.com/exk3qwgtjhetR2Od****
SSOStatus	string	SSO 登入的啟用狀態。取值： Enabled：啟用。 Disabled：禁用。	Disabled
DirectoryId	string	目錄 ID。	d-00fc2p61****
EncodedMetadataDocument	string	IdP 中繼資料文檔（Base 64 編碼）。	PD94bWwgdmVyc2lvbj0iMS4****
CreateTime	string	首次配置 IdP 的時間。	2021-11-10T02:57:16Z
WantRequestSigned	boolean	在使用者訪問雲 SSO 登入頁面發起 SAML SSO 時，是否要求雲 SSO 發送簽名的 SAML 請求。取值： true：要求雲 SSO 發送簽名的 SAML 請求。 false（預設值）：不要求雲 SSO 發送簽名的 SAML 請求。	false
UpdateTime	string	最近一次修改 IdP 配置的時間。	2021-11-10T02:57:16Z
CertificateIds	array	SAML 簽署憑證 ID。
	string	SAML 簽署憑證 ID。多個 ID 之間用半形逗號（,）分隔。	[ "idp-c-00buzdx63z8ewtdf**", "idp-c-00gmuxnr2mrek3t2**" ]
LoginUrl	string	IdP 的登入地址。	https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
BindingType	string	發起 SAML 請求的 Binding 方式。取值： Post：以 Post 的方式發起 SAML 請求。 Redirect：以 Redirect 的方式發起 SAML 請求。	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"
  }
}

錯誤碼

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

變更歷史

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