Mettre à jour les connexions par ID

Met à jour les détails d’une connexion, y compris les propriétés d’option servant à configurer le fournisseur d’identité.

Remarque : Si vous utilisez le paramètre options, l’objet options au complet est remplacé. Pour éviter des données partielles ou d’autres problèmes, assurez-vous que tous les paramètres sont présents lorsque vous utilisez cette option.

PATCH https://{tenantDomain}/api/v2/connections/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Connections.UpdateAsync(
            id: "id",
            request: new UpdateConnectionRequestContent()
        );
    }

}

200

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "allow_missing_user_id": true,
    "cross_app_access": true
  },
  "cross_app_access_requesting_app": {
    "active": true
  },
  "cross_app_access_resource_app": {},
  "display_name": "<string>",
  "enabled_clients": [
    "<string>"
  ],
  "id": "con_0000000000000001",
  "is_domain_connection": true,
  "metadata": {},
  "name": "My connection",
  "options": {},
  "realms": [
    "<string>"
  ],
  "show_as_button": true,
  "strategy": "auth0"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

L’ID de la connexion à mettre à jour

Corps

application/jsonapplication/x-www-form-urlencoded

authentication · object · GA

Configure l’objectif d’une connexion à utiliser pour l’authentification pendant la connexion.

Show child attributes

connected_accounts · object · GA

Configurer l’usage d’une connexion pour les comptes connectés et Token Vault.

Show child attributes

cross_app_access_requesting_app · object · EA

Configurez la connexion à utiliser comme application demandeuse pour Cross App Access.

Show child attributes

cross_app_access_resource_app · object | null · EA

Accès interapplications - paramètres de l’application de ressources applicables à cette connexion.

Show child attributes

display_name · string

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.

Maximum string length: 128

enabled_clients · string<client-id>[] | null · deprecated

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

is_domain_connection · boolean

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.)

metadata · object

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é.

Show child attributes

options · object | null

Les 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.

Show child attributes

realms · string<connection-realm>[]

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

show_as_button · boolean

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.)

Réponse

200

application/json

La connexion a été mise à jour.

authentication · object · GA

Configure l’objectif d’une connexion à utiliser pour l’authentification pendant la connexion.

Show child attributes

connected_accounts · object · GA

Configurer l’usage d’une connexion pour les comptes connectés et Token Vault.

Show child attributes

cross_app_access_requesting_app · object · EA

Configurez la connexion à utiliser comme application demandeuse pour Cross App Access.

Show child attributes

cross_app_access_resource_app · object · EA

Paramètres de l’application de ressources Cross App Access qui s’appliquent à cette connexion.

Show child attributes

display_name · string

Nom de la connexion utilisé dans l’écran de connexion

enabled_clients · string[] · deprecated

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

id · string · défaut: con_0000000000000001

L’identifiant de la connexion

is_domain_connection · boolean

Vrai si la connexion est au niveau du domaine

metadata · object

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é.

Show child attributes

name · string · défaut: My connection

Le nom de la connexion

options · object

Pour renvoyer les options dans la réponse, le scope read:connections_options doit être présent

realms · string<connection-realm>[]

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

show_as_button · boolean

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.

strategy · string · défaut: auth0

Le type de connexion, lié au fournisseur d’identité