接続 ID による有効化済み接続の部分更新

現在組織で有効になっている特定の接続の詳細を変更します。

PATCH https://{tenantDomain}/api/v2/organizations/{id}/enabled_connections/{connectionId}

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.UpdateOrganizationConnectionRequestContent{}
    client.Organizations.EnabledConnections.Update(
        context.TODO(),
        "id",
        "connectionId",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.update("id", "connectionId", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.update("id", "connectionId", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/organizations/{id}/enabled_connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assign_membership_on_login": true,
  "is_signup_enabled": true,
  "show_as_button": true
}
'

import requests

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

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations/{id}/enabled_connections/{connectionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'assign_membership_on_login' => true,
    'is_signup_enabled' => true,
    '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;
}

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

require 'uri'
require 'net/http'

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

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

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

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

200

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

connectionId · string · 必須

接続の識別子。

Required string length: 1 - 50

ボディ

application/jsonapplication/x-www-form-urlencoded

assign_membership_on_login · boolean

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

is_signup_enabled · boolean

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

show_as_button · boolean

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

レスポンス

200

application/json

組織の接続が正常に更新されました。

assign_membership_on_login · boolean

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

connection · object

Show child attributes

connection_id · string

接続の id。

is_signup_enabled · boolean

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

show_as_button · boolean

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