Modifier les connexions activées par ID de connexion

Modifiez les détails d’une connexion précise actuellement activée pour une Organisation.

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
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

Identifiant de l’Organisation.

Maximum string length: 50

connectionId · string · requis

Identifiant de la Connexion.

Required string length: 1 - 50

Corps

application/jsonapplication/x-www-form-urlencoded

assign_membership_on_login · boolean

Lorsque la valeur est true, tous les utilisateurs qui se connectent avec cette connexion se verront automatiquement accorder une appartenance à l’organisation. Lorsque la valeur est false, les utilisateurs doivent obtenir une appartenance à l’organisation avant de se connecter avec cette connexion.

is_signup_enabled · boolean

Détermine si l’inscription à l’organisation doit être activée pour cette connexion de l’organisation. S’applique uniquement aux connexions de base de données. Par défaut : false.

show_as_button · boolean

Détermine si une connexion doit être affichée dans l’invite de connexion de cette organisation. S’applique uniquement aux connexions d’entreprise. Par défaut : true.

Réponse

200

application/json

Connexion de l’organisation mise à jour avec succès.

assign_membership_on_login · boolean

Lorsque la valeur est true, tous les utilisateurs qui se connectent avec cette connexion se verront automatiquement accorder une appartenance à l’organisation. Lorsque la valeur est false, les utilisateurs doivent obtenir une appartenance à l’organisation avant de se connecter avec cette connexion.

connection · object

Show child attributes

connection_id · string

ID de la connexion.

is_signup_enabled · boolean

Détermine si l’inscription à l’organisation doit être activée pour cette connexion de l’organisation. S’applique uniquement aux connexions de base de données. Par défaut : false.

show_as_button · boolean

Détermine si une connexion doit être affichée dans l’invite de connexion de cette organisation. S’applique uniquement aux connexions d’entreprise. Par défaut : true.