ID で接続を取得

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

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/connections/{id}",
  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;
}

require 'uri'
require 'net/http'

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

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

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "cross_app_access": true
  },
  "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}

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

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/connections/{id}",
  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;
}

require 'uri'
require 'net/http'

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

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

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "cross_app_access": true
  },
  "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

display_name

string

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

enabled_clients

string[]

deprecated

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

クライアント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プロバイダーに関連する接続の種類

接続を作成

id を指定して接続を削除