Crear conexiones habilitadas

Habilite una conexión específica para una Organización determinada. Para habilitar una conexión, esta ya debe existir en su inquilino; las conexiones no se pueden crear mediante esta acción.

Conexiones representan la relación entre Auth0 y una fuente de usuarios. Los tipos de conexiones disponibles incluyen base de datos, empresariales y 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
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

id · string · requerido

Identificador de la organización.

Maximum string length: 50

Cuerpo

application/jsonapplication/x-www-form-urlencoded

connection_id · string<connection-id> · requerido

Un único ID de conexión para agregar a la organización.

assign_membership_on_login · boolean

Cuando es true, a todos los usuarios que inicien sesión con esta conexión se les otorgará automáticamente la membresía en la organización. Cuando es false, se debe otorgar la membresía en la organización a los usuarios antes de que inicien sesión con esta conexión.

is_signup_enabled · boolean

Determina si se debe habilitar el registro en la organización para esta conexión de organización. Solo se aplica a las conexiones de base de datos. Valor predeterminado: false.

show_as_button · boolean

Determina si se debe mostrar una conexión en la pantalla de inicio de sesión de esta organización. Solo se aplica a las conexiones empresariales. Valor predeterminado: true.

Respuesta

201

application/json

La conexión de la organización se agregó correctamente.

assign_membership_on_login · boolean

Cuando es true, a todos los usuarios que inicien sesión con esta conexión se les otorgará automáticamente la membresía en la organización. Cuando es false, se debe otorgar la membresía en la organización a los usuarios antes de que inicien sesión con esta conexión.

connection · object

Show child attributes

connection_id · string

ID de la conexión.

is_signup_enabled · boolean

Determina si se debe habilitar el registro en la organización para esta conexión de organización. Solo se aplica a las conexiones de base de datos. Valor predeterminado: false.

show_as_button · boolean

Determina si se debe mostrar una conexión en la pantalla de inicio de sesión de esta organización. Solo se aplica a las conexiones empresariales. Valor predeterminado: true.