Obtener las conexiones habilitadas

Recupere los detalles de una conexión específica habilitada actualmente para una Organización. La información devuelta incluye detalles como el ID de la conexión, el nombre, la estrategia y si la conexión concede membresía automáticamente al iniciar sesión.

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

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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.ListOrganizationConnectionsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Organizations.EnabledConnections.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/enabled_connections \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, 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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/organizations/{id}/enabled_connections")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelva los resultados dentro de un objeto que contenga el recuento total de resultados (true) o como una matriz directa de resultados (false, valor predeterminado).

Respuesta

200

application/json

Las conexiones se recuperaron correctamente.

object[]

object

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 conexiones de base de datos. Valor predeterminado: false.

show_as_button · boolean

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