Actualizar parcialmente una conexión por id

Actualice los detalles de una conexión específica, incluidas las propiedades de las opciones para la configuración del proveedor de identidad.

Nota: Si usa el parámetro options, se reemplazará todo el objeto options. Para evitar datos parciales u otros problemas, asegúrese de que todos los parámetros estén presentes al usar esta opción.

PATCH 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.UpdateConnectionRequestContent{}
    client.Connections.Update(
        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 actualizar

Cuerpo

application/jsonapplication/x-www-form-urlencoded

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

El nombre de la conexión usado en la nueva experiencia de Universal Login. Si display_name no se incluye en la solicitud, el campo se sobrescribirá con el valor de name.

Maximum string length: 128

enabled_clients · string<client-id>[] | null · deprecated

Propiedad OBSOLETA. Use el endpoint PATCH /v2/connections/{id}/clients para habilitar o deshabilitar la conexión para cualquier cliente.

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

is_domain_connection · boolean

true la promociona a una conexión de nivel de dominio para que las aplicaciones de terceros puedan usarla. false no promociona la conexión, por lo que solo podrán usarla las aplicaciones de primera parte que tengan la conexión habilitada. (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). Para actualizar estas opciones, debe estar presente el scope update:connections_options. Para verificar los cambios, incluya también el scope read:connections_options. Si no se especifica este scope, no podrá revisar el objeto actualizado.

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 lista 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. (El valor predeterminado es false.)

Respuesta

200

application/json

La conexión se actualizó.

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 el array 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

Permite mostrar 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 la conexión, relacionado con el proveedor de identidad