using Auth0.ManagementApi;
using System.Threading.Tasks;
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.Connections.ListAsync(
            new ListConnectionsQueryParameters {
                From = "from",
                Take = 1,
                Strategy = new List<ConnectionStrategyEnum>(){
                    ConnectionStrategyEnum.Ad,
                }
                ,
                Name = "name",
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package example

import (
    context "context"

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

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

package com.example.usage;

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

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

        client.connections().list(
            ListConnectionsQueryParameters
                .builder()
                .strategy(
                    Arrays.asList(ConnectionStrategyEnum.AD)
                )
                .from("from")
                .take(1)
                .name("name")
                .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\Connections\Requests\ListConnectionsQueryParameters;
use Auth0\SDK\API\Management\Types\ConnectionStrategyEnum;

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

from auth0.management import ManagementClient

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

client.connections.list(
    from="from",
    take=1,
    strategy=[
        "ad"
    ],
    name="name",
    fields="fields",
    include_fields=True,
)

require "auth0"

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

client.connections.list(
  from: "from",
  take: 1,
  strategy: ["ad"],
  name: "name",
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.list({
        from: "from",
        take: 1,
        name: "name",
        fields: "fields",
        includeFields: true,
    });
}
main();

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

接続を取得

指定した strategy に一致するすべての接続の詳細な一覧を取得します。strategy が指定されていない場合は、tenant 内のすべての接続が取得されます。この操作では、取得結果の接続一覧に含める、または除外するフィールドの一覧を指定できます。

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

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

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

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

checkpoint で検索するには、次のパラメーターを使用します。

from: 取得を開始する位置を示す任意の ID。
take: from パラメーターの使用時に取得するエントリーの総数。既定値は 50 です。

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

GET

https://{tenantDomain}/api/v2

connections

using Auth0.ManagementApi;
using System.Threading.Tasks;
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.Connections.ListAsync(
            new ListConnectionsQueryParameters {
                From = "from",
                Take = 1,
                Strategy = new List<ConnectionStrategyEnum>(){
                    ConnectionStrategyEnum.Ad,
                }
                ,
                Name = "name",
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package example

import (
    context "context"

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

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

package com.example.usage;

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

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

        client.connections().list(
            ListConnectionsQueryParameters
                .builder()
                .strategy(
                    Arrays.asList(ConnectionStrategyEnum.AD)
                )
                .from("from")
                .take(1)
                .name("name")
                .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\Connections\Requests\ListConnectionsQueryParameters;
use Auth0\SDK\API\Management\Types\ConnectionStrategyEnum;

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

from auth0.management import ManagementClient

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

client.connections.list(
    from="from",
    take=1,
    strategy=[
        "ad"
    ],
    name="name",
    fields="fields",
    include_fields=True,
)

require "auth0"

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

client.connections.list(
  from: "from",
  take: 1,
  strategy: ["ad"],
  name: "name",
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.list({
        from: "from",
        take: 1,
        name: "name",
        fields: "fields",
        includeFields: true,
    });
}
main();

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

承認

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>[]

特定の strategy を持つ接続のみを取得するには、strategy を指定します

利用可能なオプション:

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）

レスポンス

接続を取得しました。

Option 1 · object[]
Option 2 · object
Option 3 · object

authentication

object

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

Show child attributes

connected_accounts

object

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

Show child attributes

cross_app_access_requesting_app

object

Cross App Access のリクエスト元アプリケーションとして使用する接続を設定します。

Show child attributes

cross_app_access_resource_app

object

この接続に適用される Cross App Access - Resource App の設定。

Show child attributes

display_name

string

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

string

デフォルト:con_0000000000000001

接続の識別子

is_domain_connection

boolean

接続が domain level の場合は true

metadata

object

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

Show child attributes

name

string

デフォルト:My connection

接続名

options

object

レスポンスに options を含めるには、read:connections_options scope が含まれている必要があります

realms

string<connection-realm>[]

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

この接続が属するレルム

show_as_button

boolean

strategy

string

デフォルト:auth0

アイデンティティプロバイダーに関連する接続の種類