Récupérer les connexions

Récupère la liste détaillée de toutes les connexions correspondant à la stratégie indiquée. Si aucune stratégie n’est fournie, toutes les connexions de votre locataire sont récupérées. Cette action accepte une liste de champs à inclure ou à exclure de la liste de connexions renvoyée.

Ce point de terminaison prend en charge deux types de pagination :

• Pagination par offset
• Pagination par checkpoint

La pagination par checkpoint doit être utilisée si vous devez récupérer plus de 1000 connexions.

Pagination par checkpoint

Pour effectuer une recherche par checkpoint, utilisez les paramètres suivants :

• from : id facultatif à partir duquel commencer la sélection.
• take : nombre total d’entrées à récupérer lors de l’utilisation du paramètre from. La valeur par défaut est 50.

Remarque : la première fois que vous appelez ce point de terminaison avec la pagination par checkpoint, omettez le paramètre from. S’il y a d’autres résultats, une valeur next est incluse dans la réponse. Vous pouvez l’utiliser pour les appels d’API suivants. Lorsque next n’est plus inclus dans la réponse, il n’y a plus d’autres pages.

GET https://{tenantDomain}/api/v2/connections

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.ListConnectionsQueryParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Name: management.String(
            "name",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Connections.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "authentication": {
      "active": true
    },
    "connected_accounts": {
      "active": true,
      "cross_app_access": true
    },
    "display_name": "<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 requête

per_page · integer

Le nombre d’entrées par page. La valeur par défaut est 100 si elle n’est pas fournie

Plage requise: 1 <= x <= 100

page · integer

Le numéro de page. Indexation à partir de zéro

Plage requise: x >= 0

include_totals · boolean

true si un résumé de la requête doit être inclus dans le résultat, false sinon. N’est pas renvoyé lors de l’utilisation de la pagination par checkpoint. Valeur par défaut : false.

from · string

Id facultatif à partir duquel commencer la sélection.

take · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

strategy · enum<string>[]

Indiquez des stratégies pour récupérer uniquement les connexions correspondant à ces stratégies

Options disponibles: ad, adfs, amazon, apple, dropbox, bitbucket, auth0-oidc, auth0, baidu, bitly, box, custom, daccount, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, github, google-apps, google-oauth2, instagram, ip, line, linkedin, oauth1, oauth2, office365, oidc, okta, paypal, paypal-sandbox, pingfederate, planningcenter, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, shop, sms, soundcloud, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yandex, auth0-adldap

name · string

Indiquez le nom de la connexion à récupérer

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

Les connexions ont été récupérées.

Option 1 · object[]

Option 2 · object

Option 3 · object

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

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

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si la valeur est false, elle sera utilisable uniquement par HRD.

strategy · string · défaut: auth0

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