Mettre à jour une connexion
Mettre à jour les détails d’une connexion précise, y compris les propriétés des options de configuration du fournisseur d’identité.
Remarque : Si vous utilisez le paramètre options, l’objet options entier est remplacé. Pour éviter les données partielles ou d’autres problèmes, assurez-vous que tous les paramètres sont présents lorsque vous utilisez cette option. Si des options ne sont pas précisées, la valeur par défaut sera utilisée, même si elle diffère de la valeur existante.
Autorisations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Paramètres de chemin
L’ID de la connexion à mettre à jour
Corps
Le nom de la connection utilisé dans la nouvelle Universal Login experience. Si display_name n’est pas inclus dans la request, le champ sera remplacé par la valeur de name.
128Les options de la connection (dépendent de la stratégie de connection). Pour mettre à jour ces options, le scope update:connections_options doit être présent. Pour vérifier vos modifications, incluez aussi le scope read:connections_options. Si ce scope n’est pas précisé, vous ne pourrez pas consulter l’objet mis à jour.
Propriété DEPRECATED. Utilisez le point de terminaison PATCH /v2/connections/{id}/clients pour activer ou désactiver la connection pour n’importe quels clients.
Le client_id du client pour lequel la connection doit être activée
true la promeut en connection au niveau du domaine afin que les third-party applications puissent l’utiliser. false ne promeut pas la connection; seules les first-party applications pour lesquelles la connection est activée peuvent alors l’utiliser. (Par défaut : false.)
Permet d’afficher un bouton pour la connection dans la login page (nouvelle expérience seulement). Si la valeur est false, elle ne pourra être utilisée que par HRD. (Par défaut : false.)
Définit les realms pour lesquels la connection sera utilisée (c.-à-d. les domaines de courriel). Si l’array est vide ou si la propriété n’est pas précisée, le nom de la connection sera ajouté comme realm.
Le realm auquel cette connection appartient
Métadonnées associées à la connexion sous la forme d’un objet avec des valeurs de chaîne (max. 255 caractères). Un maximum de 10 propriétés de métadonnées est autorisé.
Configure l’objectif d’une connexion à utiliser pour l’authentification pendant la connexion.
Configurer l’usage d’une connexion pour les comptes connectés et Token Vault.
Configurez la connexion à utiliser comme application demandeuse pour Cross App Access.
Accès interapplications - paramètres de l’application de ressources applicables à cette connexion.
Réponse
La connexion a été mise à jour.
Le nom de la connexion
Nom de la connexion utilisé dans l’écran de connexion
Pour renvoyer les options dans la réponse, le scope read:connections_options doit être présent
L’identifiant de la connexion
Le type de connexion, lié au fournisseur d’identité
Définit les realms pour lesquels la connexion sera utilisée (c.-à-d. les domaines de courriel). Si le tableau est vide ou si la propriété n’est pas précisée, le nom de la connexion sera ajouté comme realm.
Le realm auquel cette connexion appartient
Propriété OBSOLÈTE. Utilisez le endpoint GET /connections/:id/clients pour obtenir les ID des clients pour lesquels la connexion est activée
L’ID client
Vrai si la connexion est au niveau du domaine
Active l’affichage d’un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si false, elle ne pourra être utilisée que par HRD.
Métadonnées associées à la connexion sous la forme d’un objet avec des valeurs de chaîne (max. 255 caractères). Un maximum de 10 propriétés de métadonnées est autorisé.
Configure l’objectif d’une connexion à utiliser pour l’authentification pendant la connexion.
Configurer l’usage d’une connexion pour les comptes connectés et Token Vault.
Configurez la connexion à utiliser comme application demandeuse pour Cross App Access.
Paramètres de l’application de ressources Cross App Access qui s’appliquent à cette connexion.