組織の接続を取得

GET https://{tenantDomain}/api/v2/organizations/{id}/connections

組織に関連付けられた接続を取得

cURL

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

200

[
  {
    "connection_id": "<string>",
    "assign_membership_on_login": true,
    "connection": {
      "name": "<string>",
      "strategy": "<string>"
    },
    "is_enabled": true,
    "is_signup_enabled": true,
    "organization_connection_name": "<string>",
    "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

返される結果のページインデックスです。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

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

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

include_totals · boolean

結果の合計件数を含むオブジェクト内に結果を返すか（true）、結果の配列を直接返すか（false、既定値）を指定します。

is_enabled · boolean

有効ステータスで接続を絞り込みます。

レスポンス

200

application/json

接続を正常に取得しました。

object[]

object

connection_id · string<connection-id> · 必須

接続識別子。

Required string length: 1 - 50

assign_membership_on_login · boolean

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

connection · object

Show child attributes

is_enabled · boolean

この接続が組織で有効かどうか。

is_signup_enabled · boolean

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

organization_access_level · enum<string>

組織のアクセスレベル（例: "none"、"full"）。

利用可能なオプション: none, readonly, limited, full

organization_connection_name · string

この組織のスコープ内での接続名。

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button · boolean

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