組織の接続を作成

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Connections.CreateAsync(
            id: "id",
            request: new CreateOrganizationAllConnectionRequestParameters {
                ConnectionId = "connection_id"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationAllConnectionRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().connections().create(
            "id",
            CreateOrganizationAllConnectionRequestParameters
                .builder()
                .connectionId("connection_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Connections\Requests\CreateOrganizationAllConnectionRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->connections->create(
    'id',
    new CreateOrganizationAllConnectionRequestParameters([
        'connectionId' => 'connection_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.connections.create(
    id="id",
    connection_id="connection_id",
)

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

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));

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))

}

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

POST

https://{tenantDomain}/api/v2

organizations

{id}

connections

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Connections.CreateAsync(
            id: "id",
            request: new CreateOrganizationAllConnectionRequestParameters {
                ConnectionId = "connection_id"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationAllConnectionRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().connections().create(
            "id",
            CreateOrganizationAllConnectionRequestParameters
                .builder()
                .connectionId("connection_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Connections\Requests\CreateOrganizationAllConnectionRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->connections->create(
    'id',
    new CreateOrganizationAllConnectionRequestParameters([
        'connectionId' => 'connection_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.connections.create(
    id="id",
    connection_id="connection_id",
)

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

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));

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))

}

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

必須

organization の識別子。

Maximum string length: 50

ボディ

connection_id

string<connection-id>

必須

接続識別子。

Required string length: 1 - 50

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

is_enabled

boolean

この接続が organization に対して有効になっているかどうか。

この organization 接続で organization の Signup を有効にするかどうかを決定します。database connections にのみ適用されます。デフォルト: false。

organization_access_level

enum<string>

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

利用可能なオプション:

none,

readonly,

limited,

full

organization_connection_name

string

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

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button

boolean

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

レスポンス

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

connection_id

string<connection-id>

必須

接続識別子。

Required string length: 1 - 50

connection

object

Show child attributes

is_enabled

boolean

この接続が organization に対して有効になっているかどうか。

この organization 接続で organization の Signup を有効にするかどうかを決定します。database connections にのみ適用されます。デフォルト: false。

organization_access_level

enum<string>

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

利用可能なオプション:

none,

readonly,

limited,

full

organization_connection_name

string

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

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button

boolean

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