Récupérer les connexions de l’application

Récupère toutes les connexions activées pour l’application spécifiée au moyen de la pagination par checkpoint. Vous pouvez aussi préciser une liste de champs à inclure ou à exclure pour chaque connexion.

• Ce point de terminaison nécessite le scope read:connections et l’un des scopes read:clients ou read:client_summary.
• Remarque : la première fois que vous appelez ce point de terminaison, 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 résultats.

GET https://{tenantDomain}/api/v2/clients/{id}/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"
    clients "github.com/auth0/go-auth0/management/management/clients"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &clients.ConnectionsGetRequest{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Clients.Connections.Get(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.clients.connections.get("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.clients.connections.get("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/clients/{id}/connections \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/clients/{id}/connections"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/clients/{id}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/clients/{id}/connections")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/clients/{id}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "connections": [
    {
      "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"
    }
  ],
  "next": "<string>"
}

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

ID de l’application pour laquelle récupérer les connexions activées.

Paramètres de requête

strategy · enum<string>[]

Indiquez des stratégies pour récupérer uniquement les connexions qui utilisent 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

from · string

ID facultatif à partir duquel commencer la sélection.

Maximum string length: 1000

take · integer

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

Plage requise: 1 <= x <= 100

fields · string

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

Maximum string length: 1000

include_fields · boolean

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

Réponse

200

application/json

Succès

connections · object[] · requis

Show child attributes

next · string

Jeton suivant encodé