Usar como módulo de Node

Aprenda a usar Auth0 Deploy CLI como módulo de Node.

Deploy CLI no solo puede usarse como una CLI independiente, sino también como un módulo de Node. Esto le permite administrar recursos de Auth0 desde scripts de Node.

Para obtener una lista completa de los ajustes de configuración, lea Configurar Deploy CLI.

​

función dump

Obtiene la configuración del Tenant de Auth0 y la descarga en la máquina local.

​

Parámetros de los argumentos

​

formato

Opciones: yaml o directory. Determina el formato de los archivos de configuración de recursos exportados. Para obtener más información, consulta Formatos de configuración de recursos disponibles.

​

output_folder

Ruta. Especifica el directorio de destino donde se escribirán los archivos de configuración.

​

config

Objeto. Configura el comportamiento de la utilidad. Para obtener más información, consulta Configurar el Deploy CLI.

​

config_file

Ruta. Especifica el archivo de configuración personalizado (config.json). Para obtener más información, consulta Configurar Deploy CLI.

​

export_ids

Booleano. Cuando está activado, exporta los campos de identificador de cada recurso. Valor predeterminado: false.

​

env

Booleano. Indica si la herramienta debe usar variables de entorno o no. Valor predeterminado: false.

​

proxy_url

Una URL para enviar solicitudes a través de un proxy. Configúrala solo si estás detrás de un proxy.

​

Ejemplo

import { dump } from 'auth0-deploy-cli';

dump({
  output_folder: './local',
  format: 'yaml',
  config: {
    AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
    AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
    AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
  },
})
  .then(() => {
    console.log('Exportación de configuración de Auth0 exitosa');
  })
  .catch((err) => {
    console.log('Error durante la exportación de configuración de Auth0:', err);
  });

​

función deploy

Aplica configuraciones de la máquina local al Tenant de Auth0.

​

Parámetros de los argumentos

​

input_file

Ruta. Especifica la ubicación de los archivos de configuración de recursos. En los formatos YAML, apuntará al archivo tenant.yaml. En los formatos de directorio, apuntará al directorio de configuración de recursos.

​

config

Objeto. Configura el comportamiento de la utilidad. Para obtener más información, consulta Configurar el Deploy CLI.

​

config_file

Ruta. Especifica el archivo de configuración personalizado (config.json). Para obtener más información, consulta Configurar Deploy CLI.

​

export_ids

Booleano. Si está habilitado, exporta los campos de identificador de cada recurso. Valor predeterminado: false.

​

env

Booleano. Indica si la herramienta debe leer las variables de entorno. Valor predeterminado: false.

​

proxy_url

Una URL para enrutar solicitudes a través de un proxy. Configúrala solo si estás detrás de un proxy.

​

Ejemplo

import { deploy } from 'auth0-deploy-cli';

deploy({
  input_file: './local/tenant.yaml',
  config: {
    AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
    AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
    AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
  },
})
  .then(() => {
    console.log('Configuración de Auth0 aplicada al Tenant correctamente');
  })
  .catch((err) => {
    console.log('Error al aplicar la configuración al Tenant de Auth0:', err);
  });