Modifier une connexion par id

Met à jour les détails d’une connexion précise, y compris les propriétés des options pour la configuration du fournisseur d’identité.

Remarque : Si vous utilisez le paramètre options, l’objet options est remplacé dans son intégralité. 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}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateConnectionRequestContent{}
    client.Connections.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "cross_app_access": true
  },
  "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’usage d’une connexion à utiliser pour l’authentification lors de la connexion.

Show child attributes

connected_accounts · object · GA

Configurez l’usage d’une connexion à utiliser pour Connected Accounts et Token Vault.

Show child attributes

display_name · string

Le nom de la connexion utilisé dans la nouvelle expérience Universal Login. Si display_name n’est pas inclus dans la requête, le champ sera remplacé par la valeur de name.

Maximum string length: 128

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

Propriété OBSOLÈTE. Utilisez le point de terminaison PATCH /v2/connections/{id}/clients pour activer ou désactiver la connexion pour n’importe quelle application.

Le client_id de l’application pour laquelle la connexion doit être activée

is_domain_connection · boolean

true promeut la connexion au niveau du domaine afin que les applications tierces puissent l’utiliser. false ne promeut pas la connexion, de sorte que seules les applications de première partie pour lesquelles la connexion est activée peuvent l’utiliser. (Par défaut : false.)

metadata · object

Métadonnées associées à la connexion sous la forme d’un objet contenant des valeurs de type chaîne (max. 255 caractères). Un maximum de 10 propriétés de métadonnées est autorisé.

Show child attributes

options · object

Les options de la connexion (elles dépendent de la stratégie de connexion). 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 spécifié, vous ne pourrez pas examiner l’objet mis à jour.

Show child attributes

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 que la propriété n’est pas spécifiée, le nom de la connexion sera ajouté comme realm.

Le realm auquel cette connexion appartient

show_as_button · boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si false, elle pourra être utilisée uniquement par HRD. (Par défaut : false.)

Réponse

200

application/json

La connexion a été mise à jour.

authentication · object · GA

Configure l’usage d’une connexion à utiliser pour l’authentification lors de la connexion.

Show child attributes

connected_accounts · object · GA

Configurez l’usage d’une connexion à utiliser pour Connected Accounts et Token Vault.

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 point de terminaison GET /connections/:id/clients pour obtenir les id des applications pour lesquelles 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 contenant des valeurs de type 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 spécifiée, le nom de la connexion sera ajouté comme realm.

Le realm auquel appartient cette connexion

show_as_button · boolean

Active l’affichage d’un bouton pour la connexion sur la page de connexion (nouvelle expérience uniquement). Si false, elle sera utilisable uniquement via HRD.

strategy · string · défaut: auth0

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