Skip to main content

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 travail 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. Comme client grants et resource servers (APIs) sont des types de ressources pris en charge, Deploy CLI peut synchroniser les permissions d’API (les portées définies sur vos API) et les client grants qui autorisent les applications à accéder à ces API entre les tenants. Lorsque vous effectuez une exportation à partir d’un tenant et une importation dans un autre, la ressource resource servers (APIs) contient les définitions des API et leurs portées, tandis que la ressource client grants indique quelles applications ont accès à quelles API et avec quelles portées. Vous pouvez ainsi appliquer à votre tenant de préproduction les mêmes niveaux d’accès que ceux de vos applications du tenant de développement.
Les client grants référencent les applications et les API par identifiant : le nom du client pour les applications et audience pour les API. Les clients (applications) et resource servers (APIs) correspondants doivent également exister (ou être créés) dans le tenant cible pour que les grants soient correctement résolus.

​
Points saillants

  • Axé sur le multi-environnement : Conçu pour vous aider à tester les intégrations Auth0 de vos applications, de votre branche de fonctionnalité jusqu’à la Production.
  • Remplacement de mots-clés : Configurations de ressources partagées entre tous les environnements avec remplacement dynamique de mots-clés.
  • Polyvalent : Intégrez-le à vos flux de travail CI/CD, soit comme CLI, soit comme module Node.js.

​
Pour commencer

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

​
Installer le Deploy CLI

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

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

Pour que le Deploy CLI puisse appeler la , une application Auth0 dédiée doit être créée pour 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 explicite (par exemple « Deploy CLI »).
    2. Sélectionnez Machine to Machine Applications pour 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 permissions 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 du Deploy CLI n’est pas configurable à lui seul 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 Management. Le principe du moindre privilège est respecté, donc il fonctionnera dans les limites 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 relevant du Management. Pour autoriser les suppressions, vous avez besoin des 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 de l’une ou l’autre, ou des deux, dépend de votre cas d’utilisation 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

La commande export du Deploy CLI s’exécute à l’aide de la commande suivante : a0deploy export --format=yaml --output_folder=local Une fois le processus terminé, consultez les fichiers de configuration des ressources générés dans le répertoire local. Ensuite, exécutez 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.