Utilisation en tant que module Node

L’outil Deploy CLI peut être utilisé non seulement comme interface de ligne de commande autonome, mais aussi comme un module node. Cela vous permet de gérer les ressources Auth0 dans des scripts node expressifs.

Pour une liste complète des paramètres de configuration, veuillez consulter Configurer l’outil Deploy CLI.

Récupère les configurations du locataire Auth0 sur la machine locale.

Options : yaml ou directory. Détermine le format des fichiers de configuration des ressources exportés. Pour en savoir plus, lisez Formats de configuration des ressources disponibles.

Chemin d’accès. Spécifie le répertoire cible dans lequel les fichiers de configuration doivent être écrits.

Objet. Configure le comportement de l’utilitaire. Pour en savoir plus, consultez Configurer l’outil Deploy CLI.

Chemin d’accès. Indique le fichier de configuration défini par l’utilisateur (config.json). Pour en savoir plus, consultez Configurer l’outil Deploy CLI.

Valeur booléenne. Lorsque cette option est activée, elle exporte les champs d’identifiant de chaque ressource. Valeur par défaut : false.

Valeur booléenne. Indique si l’outil doit ingérer des variables d’environnement ou non. Valeur par défaut : false.

URL pour les demandes de proxy. Ne définissez cette option que si vous êtes derrière un proxy.

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('Auth0 configuration export successful');
  })
  .catch((err) => {
    console.log('Error during Auth0 configuration export:', err);
  });

Applique les configurations de la machine locale au locataire Auth0.

Chemin d’accès. Spécifie l’emplacement des fichiers de configuration des ressources. Pour les formats YAML, il pointera vers le fichier tenant.yaml. Pour les formats de répertoire, ce chemin pointera vers le répertoire de configuration des ressources.

Objet. Configure le comportement de l’utilitaire. Pour en savoir plus, consultez Configurer l’outil Deploy CLI.

Chemin d’accès. Indique le fichier de configuration défini par l’utilisateur (config.json). Pour en savoir plus, consultez Configurer l’outil Deploy CLI.

Valeur booléenne. Lorsque cette option est activée, elle exporte les champs d’identifiant de chaque ressource. Valeur par défaut : false.

Valeur booléenne. Indique si l’outil doit ingérer des variables d’environnement ou non. Valeur par défaut : false.

URL pour les demandes de proxy. Ne définissez cette option que si vous êtes derrière un proxy.

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('Auth0 configuration applied to tenant successful');
  })
  .catch((err) => {
    console.log('Error when applying configuration to Auth0 tenant:', err);
  });