Utiliser le Deploy CLI comme module Node.js

Découvrez comment utiliser le Deploy CLI d’Auth0 comme module Node.js directement depuis vos propres scripts de déploiement.

Le Auth0 Deploy CLI peut être utilisé non seulement comme CLI autonome, mais aussi comme module Node.js. Vous pouvez ainsi gérer les ressources Auth0 dans des scripts Node.js plus souples.

Pour obtenir une liste complète des options de configuration, veuillez consulter Configurer le Deploy CLI.

​

fonction dump

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

​

Paramètres

​

format

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

​

output_folder

Chemin. Spécifie le répertoire cible dans lequel les fichiers de configuration seront écrits.

​

config

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

​

config_file

Chemin. Spécifie le fichier de configuration personnalisé (config.json). Pour en savoir plus, consultez Configurer le Deploy CLI.

​

export_ids

Booléen. Si cette option est activée, les champs d’identifiant de chaque ressource seront exportés. Par défaut : false.

​

env

Booléen. Indique si l’outil doit charger les variables d’environnement. Par défaut : false.

​

proxy_url

Une URL pour faire passer les requêtes par un serveur proxy. À définir uniquement si vous êtes derrière un proxy.

​

Exemple

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('Exportation de la configuration Auth0 réussie');
  })
  .catch((err) => {
    console.log('Erreur lors de l\'exportation de la configuration Auth0 :', err);
  });

​

fonction de déploiement

Applique les configurations de la machine locale au tenant Auth0.

​

Paramètres

​

input_file

Chemin. Indique 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, il pointera vers le répertoire de configuration des ressources.

​

config

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

​

config_file

Chemin. Spécifie le fichier de configuration personnalisé (config.json). Pour en savoir plus, consultez Configurer le Deploy CLI.

​

export_ids

Booléen. Si cette option est activée, les champs d’identifiant de chaque ressource seront exportés. Par défaut : false.

​

env

Booléen. Indique si l’outil doit charger les variables d’environnement. Par défaut : false.

​

proxy_url

Une URL pour faire passer les requêtes par un serveur proxy. À définir uniquement si vous êtes derrière un proxy.

​

Exemple

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('Configuration Auth0 appliquée au locataire avec succès');
  })
  .catch((err) => {
    console.log('Erreur lors de l\'application de la configuration au tenant Auth0 :', err);
  });