Skip to main content
Element Software
12.5 and 12.7
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

UpdateIdpConfiguration

Contributeurs
PDF

Vous pouvez utiliser le UpdateIdpConfiguration Méthode de mise à jour d'une configuration existante avec un IDP tiers pour le cluster.

Paramètres

Cette méthode présente les paramètres d'entrée suivants :

Nom Description Type Valeur par défaut Obligatoire

GenerateNewCertificate

Lorsqu'elle est définie comme vrai, une nouvelle clé SAML et un nouveau certificat sont générés et remplacent la paire existante. Remarque : le remplacement du certificat existant entraînera une perturbation de la confiance établie entre le cluster et le IDP jusqu'à ce que les métadonnées du fournisseur de services du cluster soient rechargées au niveau du IDP. Si elle n'est pas fournie ou définie sur FALSE, le certificat et la clé SAML restent inchangés.

booléen

Aucune

Non

ID de configuration idpConfigurationID

UUID pour la configuration IDP tierce.

UUID

Aucune

Non

IdpMetadata

Métadonnées IDP pour la configuration et l'intégration de SAML 2.0 Single Sign-on.

chaîne

Aucune

Non

IdpName

Nom utilisé pour identifier et récupérer un fournisseur IDP pour l'authentification unique SAML 2.0.

chaîne

Aucune

Non

NewIdpName

Si ce nom est spécifié, il remplace l'ancien nom IDP.

chaîne

Aucune

Non

Valeurs de retour

Cette méthode a la valeur de retour suivante :

Nom

Description

Type

IdpConfigInfo

Informations relatives à la configuration IDP tierce.

"IdpConfigInfo"

Exemple de demande

Les demandes pour cette méthode sont similaires à l'exemple suivant :

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

Exemple de réponse

Cette méthode renvoie une réponse similaire à l'exemple suivant :

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

Nouveau depuis la version

12.0