Skip to main content
Element Software
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

UpdateIdpKonfiguration

Beitragende
PDFs

Sie können die Methode verwenden UpdateIdpConfiguration, um eine vorhandene Konfiguration mit einem IdP eines Drittanbieters für das Cluster zu aktualisieren.

Parameter

Diese Methode verfügt über die folgenden Eingabeparameter:

Name Beschreibung Typ Standardwert Erforderlich

GenerateNewCertificate

Wenn True angegeben wird, wird ein neuer SAML-Schlüssel und ein neues Zertifikat generiert und das vorhandene Paar ersetzt. Hinweis: Durch das Ersetzen des vorhandenen Zertifikats wird das etablierte Vertrauen zwischen dem Cluster und dem IdP unterbrochen, bis die Metadaten des Clusters am IdP neu geladen sind. Wenn nicht angegeben oder auf false gesetzt, bleiben SAML-Zertifikat und -Schlüssel unverändert.

boolesch

Keine

Nein

IdpKonfigurationID

UUID für die IdP-Konfiguration eines Drittanbieters.

UUID

Keine

Nein

IdpMetadaten

IDP-Metadaten für Konfigurations- und Integrationsdetails für SAML 2.0 Single Sign-On.

Zeichenfolge

Keine

Nein

IdpName

Name, der zum Identifizieren und Abrufen eines IdP-Providers für SAML 2.0 Single Sign-On verwendet wird.

Zeichenfolge

Keine

Nein

NewIdpName

Wenn angegeben, ersetzt dieser Name den alten IdP-Namen.

Zeichenfolge

Keine

Nein

Rückgabewerte

Diese Methode hat den folgenden Rückgabewert:

Name

Beschreibung

Typ

IdpConfigInfo

Informationen rund um die IdP-Konfiguration von Drittanbietern.

"IdpConfigInfo"

Anforderungsbeispiel

Anforderungen für diese Methode sind ähnlich wie das folgende Beispiel:

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

Antwortbeispiel

Diese Methode gibt eine Antwort zurück, die dem folgenden Beispiel ähnelt:

{
    "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"
        }
    }
}

Neu seit Version

12,0