Obtener conexiones

Recupera una lista detallada de todas las conexiones que coincidan con la strategy especificada. Si no se proporciona ninguna strategy, se recuperan todas las conexiones de su inquilino. Esta acción puede aceptar una lista de campos para incluir o excluir de la lista de conexiones resultante.

Este endpoint admite dos tipos de paginación:

• Paginación por offset
• Paginación por punto de control

Se debe usar la paginación por punto de control si necesita recuperar más de 1000 conexiones.

Paginación por punto de control

Para buscar por punto de control, use los siguientes parámetros:

• from: id opcional a partir del cual iniciar la selección.
• take: La cantidad total de entradas que se recuperarán al usar el parámetro from. El valor predeterminado es 50.

Nota: La primera vez que llame a este endpoint mediante paginación por punto de control, omita el parámetro from. Si hay más resultados, se incluye un valor next en la respuesta. Puede usarlo en llamadas posteriores a la API. Cuando next ya no se incluya en la respuesta, no quedarán más páginas.

GET https://{tenantDomain}/api/v2/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"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListConnectionsQueryParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Name: management.String(
            "name",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Connections.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "authentication": {
      "active": true
    },
    "connected_accounts": {
      "active": true,
      "cross_app_access": true
    },
    "display_name": "<string>",
    "id": "con_0000000000000001",
    "is_domain_connection": true,
    "metadata": {},
    "name": "My connection",
    "options": {},
    "realms": [
      "<string>"
    ],
    "show_as_button": true,
    "strategy": "auth0"
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

per_page · integer

La cantidad de entradas por página. El valor predeterminado es 100 si no se proporciona

Rango requerido: 1 <= x <= 100

page · integer

El número de página. Basado en cero

Rango requerido: x >= 0

include_totals · boolean

true si se debe incluir un resumen de la consulta en el resultado; de lo contrario, false. No se devuelve cuando se usa paginación por punto de control. El valor predeterminado es false.

from · string

Id opcional a partir del cual iniciar la selección.

take · integer

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

Rango requerido: 1 <= x <= 100

strategy · enum<string>[]

Proporcione strategies para recuperar solo las conexiones que usen esas strategies

Opciones disponibles: ad, adfs, amazon, apple, dropbox, bitbucket, auth0-oidc, auth0, baidu, bitly, box, custom, daccount, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, github, google-apps, google-oauth2, instagram, ip, line, linkedin, oauth1, oauth2, office365, oidc, okta, paypal, paypal-sandbox, pingfederate, planningcenter, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, shop, sms, soundcloud, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yandex, auth0-adldap

name · string

Proporcione el nombre de la conexión que desea recuperar

fields · string

Una lista de campos separados por comas para incluir o excluir (según include_fields) del resultado; déjela vacía para recuperar todos los campos

include_fields · boolean

true si los campos especificados deben incluirse en el resultado; de lo contrario, false (el valor predeterminado es true)

Respuesta

200

application/json

Las conexiones se recuperaron.

Option 1 · object[]

Option 2 · object

Option 3 · object

authentication · object · GA

Configure el propósito de una conexión para usarla en la autenticación durante el inicio de sesión.

Show child attributes

connected_accounts · object · GA

Configure el propósito de una conexión para usarla con cuentas conectadas y Token Vault.

Show child attributes

display_name · string

Nombre de la conexión usado en la pantalla de inicio de sesión

id · string · predeterminado: con_0000000000000001

El identificador de la conexión

is_domain_connection · boolean

True si la conexión es de nivel de dominio

metadata · object

Metadatos asociados a la conexión en forma de objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 10 propiedades de metadatos.

Show child attributes

name · string · predeterminado: My connection

El nombre de la conexión

options · object

Para devolver opciones en la respuesta, debe estar presente el scope read:connections_options

realms · string<connection-realm>[]

Define los realm para los que se usará la conexión (es decir, dominios de correo electrónico). Si el arreglo está vacío o no se especifica la propiedad, el nombre de la conexión se agregará como realm.

El realm al que pertenece esta conexión

show_as_button · boolean

Habilita la visualización de un botón para la conexión en la página de inicio de sesión (solo en la nueva experiencia). Si es false, solo se podrá usar mediante HRD.

strategy · string · predeterminado: auth0

El tipo de la conexión, relacionado con el proveedor de identidad