Obtenir une connexion par id

Récupère les détails d’une connexion donnée, ainsi que les options pouvant être utilisées pour la configuration du fournisseur d’identité.

GET 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.GetConnectionRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Connections.Get(
        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 à récupérer

Paramètres de requête

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure du résultat (selon include_fields); laissez vide pour récupérer tous les champs

include_fields · boolean

true si les champs indiqués doivent être inclus dans le résultat, false sinon (la valeur par défaut est true)

Réponse

200

application/json

La connexion a été récupérée.

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 ids 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

True 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 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 uniquement). Si false, elle sera utilisable uniquement par HRD.

strategy · string · défaut: auth0

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