組織コネクションを作成

curl --request POST \ --url https://{tenantDomain}/api/v2/organizations/{id}/connections \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "connection_id": "<string>", "assign_membership_on_login": true, "is_enabled": true, "is_signup_enabled": true, "organization_connection_name": "<string>", "show_as_button": true } '

{ "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 }

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

組織の識別子。

Maximum string length: 50

ボディ

connection_id

string<connection-id>

必須

接続の識別子。

Required string length: 1 - 50

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

is_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。

レスポンス

接続が正常に作成されました。

connection_id

string<connection-id>

必須

接続の識別子。

Required string length: 1 - 50

connection

object

Show child attributes

is_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。