クライアントの接続を取得する

チェックポイントページネーションを使用して、指定したアプリケーションで有効になっているすべての接続を取得します。各接続について、結果に含めるフィールドまたは除外するフィールドのリストを指定することもできます。

• このエンドポイントには、read:connections スコープと、read:clients または read:client_summary のいずれか 1 つが必要です。
• 注: このエンドポイントを初めて呼び出すときは、from パラメーターを省略してください。さらに結果がある場合は、レスポンスに next の値が含まれます。これは以降の API 呼び出しで使用できます。レスポンスに next が含まれなくなった時点で、残りの結果はありません。

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &clients.ConnectionsGetRequest{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Clients.Connections.Get(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "connections": [
    {
      "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"
    }
  ],
  "next": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

有効な接続を取得する対象のクライアントの ID。

クエリパラメータ

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

from · string

選択を開始する位置を示す省略可能な Id。

Maximum string length: 1000

take · integer

ページあたりの結果数。既定値は 50 です。

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

fields · string

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

Maximum string length: 1000

include_fields · boolean

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

レスポンス

200

application/json

成功

connections · object[] · 必須

Show child attributes

next · string

エンコードされた次のトークン