有効な接続を取得する

現在 Organization で有効になっている特定の接続の詳細を取得します。返される情報には、接続 ID、名前、ストラテジー、ログイン時にその接続で自動的にメンバーシップが付与されるかどうかなどが含まれます。

GET https://{tenantDomain}/api/v2/organizations/{id}/enabled_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"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.ListOrganizationConnectionsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Organizations.EnabledConnections.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

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

import requests

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

require 'uri'
require 'net/http'

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

[
  {
    "assign_membership_on_login": true,
    "connection": {
      "name": "<string>",
      "strategy": "<string>"
    },
    "connection_id": "<string>",
    "is_signup_enabled": true,
    "show_as_button": true
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

組織の識別子。

Maximum string length: 50

クエリパラメータ

page · integer

返す結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

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

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

include_totals · boolean

結果を、合計結果数を含むオブジェクトとして返すか（true）、結果の配列を直接返すか（false、デフォルト）を指定します。

レスポンス

200

application/json

接続が正常に取得されました。

object[]

object

assign_membership_on_login · boolean

true の場合、この接続でログインするすべてのユーザーに組織のメンバーシップが自動的に付与されます。false の場合、この接続でログインする前に、ユーザーへ組織のメンバーシップを付与する必要があります。

connection · object

Show child attributes

connection_id · string

接続の ID。

is_signup_enabled · boolean

この組織接続で組織のサインアップを有効にするかどうかを指定します。データベース接続にのみ適用されます。デフォルト: false。

show_as_button · boolean

この組織のログインプロンプトに接続を表示するかどうかを指定します。エンタープライズ接続にのみ適用されます。デフォルト: true。