Get enabled connections for a client

Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.

• This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
• Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Clients;
using System.Collections.Generic;

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.Clients.Connections.GetAsync(
            id: "id",
            request: new ConnectionsGetRequest {
                Strategy = new List<ConnectionStrategyEnum>(){
                    ConnectionStrategyEnum.Ad,
                }
                ,
                From = "from",
                Take = 1,
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package example

import (
    context "context"

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

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.clients.types.ConnectionsGetRequest;
import com.auth0.client.mgmt.types.ConnectionStrategyEnum;
import java.util.Arrays;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.clients().connections().get(
            "id",
            ConnectionsGetRequest
                .builder()
                .strategy(
                    Arrays.asList(ConnectionStrategyEnum.AD)
                )
                .from("from")
                .take(1)
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Clients\Connections\Requests\ConnectionsGetRequest;
use Auth0\SDK\API\Management\Types\ConnectionStrategyEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clients->connections->get(
    'id',
    new ConnectionsGetRequest([
        'strategy' => [
            ConnectionStrategyEnum::Ad->value,
        ],
        'from' => 'from',
        'take' => 1,
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.clients.connections.get(
    id="id",
    strategy=[
        "ad"
    ],
    from="from",
    take=1,
    fields="fields",
    include_fields=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.clients.connections.get(
  id: "id",
  strategy: ["ad"],
  from: "from",
  take: 1,
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>'

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

ID of the client for which to retrieve enabled connections.

クエリパラメータ

strategy · enum<string>[]

Provide strategies to only retrieve connections with such strategies

利用可能なオプション: 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

Optional Id from which to start selection.

Maximum string length: 1000

take · integer

Number of results per page. Defaults to 50.

必須範囲: 1 <= x <= 100

fields · string

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields

Maximum string length: 1000

include_fields · boolean

true if the fields specified are to be included in the result, false otherwise (defaults to true)

レスポンス

200

application/json

Success

connections · object[] · 必須

Show child attributes

next · string

Encoded next token