Skip to main content
Element Software
12.5 and 12.7
本繁體中文版使用機器翻譯,譯文僅供參考,若與英文版本牴觸,應以英文版本為準。

更新IdpConfiguration

貢獻者

您可以使用「更新IdpConfiguration」方法、使用叢集的協力廠商IDP來更新現有組態。

參數

此方法具有下列輸入參數:

名稱 說明 類型 預設值 必要

GenerateNewCertificate

如果指定為true、則會產生新的SAML金鑰和憑證、並取代現有配對。附註:更換現有的憑證將會中斷叢集與IDP之間建立的信任關係、直到叢集的服務供應商中繼資料在IDP重新載入為止。如果未提供或設定為假、SAML憑證和金鑰將維持不變。

布林值

idpConfiguration ID

協力廠商IDP組態的UUID。

UUID

idp中繼 資料

IDP中繼資料、提供SAML 2.0單一登入的組態與整合詳細資料。

字串

idpName

用於識別及擷取SAML 2.0單一登入的IDP供應商名稱。

字串

newIdpName

如果指定、此名稱會取代舊的IDP名稱。

字串

傳回值

此方法具有下列傳回值:

名稱

說明

類型

idpConfigInfo

第三方IDP組態的相關資訊。

申請範例

此方法的要求類似於下列範例:

{
"method": "UpdateIdpConfiguration",
"params": {
        "idpConfigurationID": "f983c602-12f9-4c67-b214-bf505185cfed",
        "generateNewCertificate": true
    }
}

回應範例

此方法會傳回類似下列範例的回應:

{
    "result": {
        "idpConfigInfo": {
        "enabled": true,
        "idpConfigurationID": "f983c602-12f9-4c67-b214-bf505185cfed",
        "idpMetadata": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n
        <EntityDescriptor xmlns=\"urn:oasis:names:tc:SAML:2.0:metadata\"\r\n
        xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"\r\n
        xmlns:shibmd=\"urn:mace:shibboleth:metadata:1.0\"\r\n
        xmlns:xml=\"http://www.w3.org/XML/1998/namespace\"\r\n
        ...</Organization>\r\n
        </EntityDescriptor>",
        "idpName": "https://privider.name.url.com",
        "serviceProviderCertificate": "-----BEGIN CERTIFICATE-----\n
        MI...BHi\n
        -----END CERTIFICATE-----\n",
        "spMetadataUrl": "https://10.193.100.100/auth/ui/saml2"
        }
    }
}

新的自版本

12.0