組織コネクションを作成

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

接続を組織に追加

cURL

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
}
'

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/connections"

payload = {
    "connection_id": "<string>",
    "assign_membership_on_login": True,
    "is_enabled": True,
    "is_signup_enabled": True,
    "organization_connection_name": "<string>",
    "show_as_button": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connection_id: '<string>',
    assign_membership_on_login: true,
    is_enabled: true,
    is_signup_enabled: true,
    organization_connection_name: '<string>',
    show_as_button: true
  })
};

fetch('https://{tenantDomain}/api/v2/organizations/{id}/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations/{id}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => '<string>',
    'assign_membership_on_login' => true,
    'is_enabled' => true,
    'is_signup_enabled' => true,
    'organization_connection_name' => '<string>',
    'show_as_button' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/organizations/{id}/connections"

	payload := strings.NewReader("{\n  \"connection_id\": \"<string>\",\n  \"assign_membership_on_login\": true,\n  \"is_enabled\": true,\n  \"is_signup_enabled\": true,\n  \"organization_connection_name\": \"<string>\",\n  \"show_as_button\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/organizations/{id}/connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\n  \"assign_membership_on_login\": true,\n  \"is_enabled\": true,\n  \"is_signup_enabled\": true,\n  \"organization_connection_name\": \"<string>\",\n  \"show_as_button\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"<string>\",\n  \"assign_membership_on_login\": true,\n  \"is_enabled\": true,\n  \"is_signup_enabled\": true,\n  \"organization_connection_name\": \"<string>\",\n  \"show_as_button\": true\n}"

response = http.request(request)
puts response.read_body

201

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

ボディ

application/jsonapplication/x-www-form-urlencoded

connection_id · string<connection-id> · 必須

接続の識別子。

Required string length: 1 - 50

assign_membership_on_login · boolean

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

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。

レスポンス

201

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。