Passer au contenu principal

Avant de commencer

Configurez un tenant Auth0.
Auth0 Deploy CLI est un outil qui vous aide à gérer la configuration de votre tenant Auth0. Il s’intègre à vos flux de développement en tant que CLI autonome ou comme module Node.js. Types de ressources pris en charge : actions, branding, client grants, clients (applications), connections, custom domains, email templates, emails, grants, guardian, hook secrets, log streams, migrations, organizations, pages, prompts, resource servers (APIs), roles, tenant settings, themes.

​
Points saillants

  • Conçu pour plusieurs environnements : Pensé pour vous aider à tester les intégrations Auth0 de vos applications, de la branche de fonctionnalité jusqu’à la production.
  • Remplacement de mots-clés : Configurations de ressources partagées entre tous les environnements, avec remplacement dynamique des mots-clés.
  • Polyvalent : Intégrez-le à vos flux de travail CI/CD, que ce soit comme CLI ou comme module Node.

​
Pour commencer

Ce guide vous aidera à mettre en œuvre l’outil Deploy CLI en tant que CLI autonome. Trois grandes étapes sont nécessaires avant de pouvoir exécuter Deploy CLI :
  1. Créer une application Auth0 dédiée
  2. Configurer Deploy CLI
  3. Appeler Deploy CLI
Cet outil peut entraîner des modifications destructrices dans votre tenant Auth0. Nous vous recommandons de bien comprendre la configuration AUTH0_ALLOW_DELETE et d’effectuer des tests sur des tenants de développement avant de l’utiliser en production.

​
Installer l’outil Deploy CLI

Pour l’utiliser comme outil autonome en ligne de commande : npm install -g auth0-deploy-cli

​
Créer une application Auth0 dédiée

Pour que Deploy CLI puisse appeler la , vous devez créer une application Auth0 dédiée afin qu’elle puisse effectuer des appels au nom de l’outil :
  1. Accédez à Auth0 Dashboard > Applications > Applications.
  2. Sélectionnez + Create Application.
    1. Donnez-lui un nom descriptif (par exemple « Deploy CLI »).
    2. Sélectionnez Machine to Machine Applications comme Application Type.
    3. Sélectionnez Create.
  3. Passez à la vue Authorize Machine to Machine Application :
    1. Sélectionnez Auth0 Management API.
    2. Sélectionnez les autorisations appropriées pour les ressources que vous souhaitez gérer. Consultez la section Client Scopes pour en savoir plus.
    3. Sélectionnez Authorize.
Le client de Deploy CLI ne peut pas être configuré directement afin d’éviter des modifications potentiellement destructrices.

​
Portées du client

L’application désignée doit se voir accorder des portées afin de permettre au Deploy CLI d’exécuter des opérations de gestion. Le principe du moindre privilège est respecté; il fonctionnera donc selon l’ensemble des autorisations accordées. Vous devrez sélectionner read:clients, mais il est recommandé de sélectionner les autorisations read:*, create:* et update:* pour tous les types de ressources visés par la gestion. Pour autoriser les suppressions, vous devez ajouter les portées delete:*.

​
Configurer le Deploy CLI

Vous pouvez configurer le Deploy CLI de deux façons :
  1. Utiliser le fichier de configuration (config.json).
  2. Définir des variables d’environnement.
Le choix d’utiliser l’une ou l’autre, ou les deux, dépend de votre cas d’usage et de vos préférences. Pour en savoir plus, consultez Configurer le Deploy CLI. Pour cet exemple, définissez les variables d’environnement suivantes :
  • AUTH0_DOMAIN
  • AUTH0_CLIENT_ID
  • AUTH0_CLIENT_SECRET
Vous trouverez ces valeurs dans l’onglet Settings de l’application Auth0 dédiée que vous avez créée précédemment.

​
Exécuter le Deploy CLI

Vous pouvez exécuter la commande export du Deploy CLI à l’aide de la commande suivante : a0deploy export --format=yaml --output_folder=local Une fois le processus terminé, examinez les fichiers de configuration des ressources générés dans le répertoire local. Exécutez ensuite la commande import pour envoyer la configuration de votre machine locale vers votre tenant Auth0 : a0deploy import --config_file=config.json --input_file local/tenant.yaml Pour obtenir la liste complète des indicateurs et des options, consultez Utiliser comme CLI.