Utiliser comme module Node.js

Découvrez comment utiliser le Deploy CLI d’Auth0 comme module Node.js.

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

Pour obtenir la liste complète des paramètres de configuration, consultez Configurer le Deploy CLI.

​

fonction dump

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

​

Paramètres des arguments

​

format

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

​

output_folder

Chemin. Indique le répertoire cible dans lequel écrire les fichiers de configuration.

​

config

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

​

config_file

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

​

export_ids

Booléen. Lorsqu’elle est activée, cette option exporte les champs d’identifiant de chaque ressource. Par défaut : false.

​

env

Booléen. Indique si l’outil doit utiliser les variables d’environnement ou non. Valeur par défaut : false.

​

proxy_url

URL utilisée pour acheminer les requêtes via un proxy. Définissez-la 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 deploy

Applique la configuration de la machine locale au locataire Auth0.

​

Paramètres des arguments

​

input_file

Chemin. Indique l’emplacement des fichiers de configuration des ressources. Pour les formats YAML, il pointe vers le fichier tenant.yaml. Pour les formats de répertoire, il pointe vers le répertoire de configuration des ressources.

​

config

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

​

config_file

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

​

export_ids

Booléen. Lorsqu’elle est activée, cette option exporte les champ d’identifiant de chaque ressource. Valeur par défaut : false.

​

env

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

​

proxy_url

URL utilisée pour acheminer les requêtes via un proxy. Définissez-la 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 locataire Auth0 :', err);
  });