POST des connexions activées

Activez une connexion spécifique pour une organisation donnée. Pour activer une connexion, elle doit déjà exister dans votre locataire; les connexions ne peuvent pas être créées au moyen de cette action.

Connexions représente la relation entre Auth0 et une source d’utilisateurs. Les types de connexions disponibles comprennent les connexions de base de données, d’entreprise et sociales.

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

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.AddOrganizationConnectionRequestContent{
        ConnectionId: "connection_id",
    }
    client.Organizations.EnabledConnections.Add(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

import requests

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

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

response = requests.post(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",
  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_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.post("https://{tenantDomain}/api/v2/organizations/{id}/enabled_connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\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")

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_signup_enabled\": true,\n  \"show_as_button\": true\n}"

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

201

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

Corps

application/jsonapplication/x-www-form-urlencoded

connection_id · string<connection-id> · requis

ID d’une seule connexion à ajouter à l’organisation.

assign_membership_on_login · boolean

Lorsque la valeur est true, tous les utilisateurs qui se connectent avec cette connexion obtiennent automatiquement 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. Valeur 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. Valeur par défaut : true.

Réponse

201

application/json

Connexion d’organisation ajoutée avec succès.

assign_membership_on_login · boolean

Lorsque la valeur est true, tous les utilisateurs qui se connectent avec cette connexion obtiennent automatiquement 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. Valeur 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. Valeur par défaut : true.