Crear conexiones

Crea una nueva conexión según el objeto JSON recibido en body.

Nota: Si hace poco se eliminó una conexión con el mismo nombre y tenía una gran cantidad de usuarios asociados, es posible que la eliminación aún siga en proceso. Crear una nueva conexión con ese nombre antes de que finalice la eliminación puede fallar o producir resultados inesperados.

POST 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.CreateConnectionRequestContent{
        Name: "name",
        Strategy: management.ConnectionIdentityProviderEnumAd,
    }
    client.Connections.Create(
        context.TODO(),
        request,
    )
}

201

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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

name · string · requerido

El nombre de la conexión. Debe comenzar y terminar con un carácter alfanumérico y solo puede contener caracteres alfanuméricos y '-'. Longitud máxima: 128

Maximum string length: 128

Pattern: ^[a-zA-Z0-9](-[a-zA-Z0-9]|[a-zA-Z0-9])*$

strategy · enum<string> · requerido

El identificador del proveedor de identidad para la conexión

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

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 nueva experiencia de Universal Login

Maximum string length: 128

enabled_clients · string<client-id>[]

NO SE RECOMIENDA el uso de esta propiedad. Use el endpoint PATCH /v2/connections/{id}/clients para habilitar la conexión para un conjunto de clientes.

El id del cliente para el cual se debe habilitar la conexión.

is_domain_connection · boolean

true promueve la conexión al nivel de dominio para que las aplicaciones de terceros puedan usarla. false no promueve la conexión, por lo que solo las aplicaciones de primera parte con la conexión habilitada pueden usarla. (El valor predeterminado es false.)

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

options · object

Las opciones de la conexión (dependen de la estrategia de conexión)

Show child attributes

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

Permite mostrar un botón para la conexión en la página de Login (solo en la nueva experiencia). Si es false, solo podrá usarse mediante HRD. (El valor predeterminado es false.)

Respuesta

201

application/json

La conexión se creó.

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 realms 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, se agregará el nombre de la conexión 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 pantalla 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 conexión, relacionado con el Proveedor de identidad