Obtener conexión por id

Recupere los detalles de una conexión especificada junto con las opciones que se pueden usar para la configuración del proveedor de identidad.

GET https://{tenantDomain}/api/v2/connections/{id}

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.GetConnectionRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Connections.Get(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "cross_app_access": true
  },
  "display_name": "<string>",
  "enabled_clients": [
    "<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 ruta

id · string · requerido

El id de la conexión que se va a recuperar

Parámetros de consulta

fields · string

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

include_fields · boolean

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

Respuesta

200

application/json

La conexión se recuperó.

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

enabled_clients · string[] · deprecated

Propiedad OBSOLETA. Use el endpoint GET /connections/:id/clients para obtener los id de los clientes para los que la conexión está habilitada

El ID de cliente

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 la matriz está vacía 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 podrá usarse mediante HRD.

strategy · string · predeterminado: auth0

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