ID で接続を取得

using Auth0.ManagementApi;
using System.Threading.Tasks;

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.GetAsync(
            id: "id",
            request: new GetConnectionRequestParameters {
                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.GetConnectionRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Connections.Get(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.GetConnectionRequestParameters;

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

        client.connections().get(
            "id",
            GetConnectionRequestParameters
                .builder()
                .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\GetConnectionRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->get(
    'id',
    new GetConnectionRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.connections.get(
    id="id",
    fields="fields",
    include_fields=True,
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.get("id", {
        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>",
  "enabled_clients": [
    "<string>"
  ],
  "id": "con_0000000000000001",
  "is_domain_connection": true,
  "metadata": {},
  "name": "My connection",
  "options": {},
  "realms": [
    "<string>"
  ],
  "show_as_button": true,
  "strategy": "auth0"
}

GET

https://{tenantDomain}/api/v2

connections

{id}

using Auth0.ManagementApi;
using System.Threading.Tasks;

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.GetAsync(
            id: "id",
            request: new GetConnectionRequestParameters {
                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.GetConnectionRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Connections.Get(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.GetConnectionRequestParameters;

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

        client.connections().get(
            "id",
            GetConnectionRequestParameters
                .builder()
                .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\GetConnectionRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->get(
    'id',
    new GetConnectionRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.connections.get(
    id="id",
    fields="fields",
    include_fields=True,
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.get("id", {
        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>",
  "enabled_clients": [
    "<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.

パスパラメータ

string

必須

取得する接続の id

クエリパラメータ

fields

string

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

include_fields

boolean

指定したフィールドを結果に含める場合は true、含めない場合は false です（既定値は true）

レスポンス

接続を取得しました。

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

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

enabled_clients

string[]

deprecated

非推奨のプロパティです。接続が有効になっているクライアントの ID を取得するには、GET /connections/:id/clients endpoint を使用してください

クライアント ID

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

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

strategy

string

デフォルト:auth0

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