接続の取得

指定したストラテジーに一致するすべての接続の詳細な一覧を取得します。ストラテジーが指定されていない場合は、テナント内のすべての接続が取得されます。このアクションでは、結果の接続一覧に含める、または除外するフィールドのリストを指定できます。

このエンドポイントは、次の 2 種類のページネーションをサポートしています。

• オフセットページネーション
• チェックポイントページネーション

1000 件を超える接続を取得する必要がある場合は、チェックポイントページネーションを使用する必要があります。

チェックポイントページネーション

チェックポイントで検索するには、次のパラメーターを使用します。

• from: 選択の開始位置となる省略可能な id。
• take: from パラメーターを使用する場合に取得するエントリーの総数。デフォルトは 50 です。

注: チェックポイントページネーションを使用してこのエンドポイントを初めて呼び出すときは、from パラメーターを省略してください。さらに結果がある場合は、レスポンスに next 値が含まれます。これは後続の API 呼び出しで使用できます。レスポンスに next が含まれなくなった時点で、残りのページはありません。

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,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

import requests

url = "https://{tenantDomain}/api/v2/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/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/connections")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/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

[
  {
    "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"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

per_page · integer

1 ページあたりのエントリー数です。指定しない場合のデフォルトは 100 です

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

page · integer

ページ番号です。0 ベースです

必須範囲: x >= 0

include_totals · boolean

クエリのサマリーを結果に含める場合は true、それ以外は false です。チェックポイントページネーションの使用時には返されません。デフォルトは false です。

from · string

選択の開始位置となる省略可能な id です。

take · integer

1 ページあたりの結果数です。デフォルトは 50 です。

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

strategy · enum<string>[]

特定のストラテジーの接続のみを取得するには、ストラテジーを指定します

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

取得する接続の名前を指定します

fields · string

結果に含める、または結果から除外する（include_fields に応じて）フィールドのカンマ区切りリストです。すべてのフィールドを取得するには空にします

include_fields · boolean

指定したフィールドを結果に含める場合は true、それ以外は false です（デフォルトは true）

レスポンス

200

application/json

接続を取得しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

authentication · object · GA

ログイン時の認証で使用する接続の用途を設定します。

Show child attributes

connected_accounts · object · GA

接続済みアカウントおよび Token Vault で使用する接続の用途を設定します。

Show child attributes

display_name · string

ログイン画面で使用される接続名

id · string · デフォルト: con_0000000000000001

接続の識別子

is_domain_connection · boolean

接続がドメインレベルの場合は true

metadata · object

文字列値（最大 255 文字）を持つオブジェクト形式の、接続に関連付けられたメタデータ。メタデータのプロパティは最大 10 個まで指定できます。

Show child attributes

name · string · デフォルト: My connection

接続の名前

options · object

レスポンスで options を返すには、read:connections_options スコープが含まれている必要があります

realms · string<connection-realm>[]

この接続で使用するレルム（例: メールドメイン）を定義します。配列が空の場合、またはプロパティが指定されていない場合は、接続名がレルムとして追加されます。

この接続が属するレルム

show_as_button · boolean

ログインページにこの接続のボタンを表示するかどうかを指定します（新しいエクスペリエンスのみ）。false の場合、HRD でのみ使用できます。

strategy · string · デフォルト: auth0

IDプロバイダーに関連付けられた接続の種類