組織の接続を取得

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

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

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id} \
  --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

connection_id · string · 必須

接続の識別子。

Required string length: 1 - 50

レスポンス

200

application/json

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

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。