Configurer le Deploy CLI

Découvrez comment configurer l’Auth0 Deploy CLI pour adapter l’outil à vos besoins.

Configurer le Deploy CLI est essentiel pour définir les identifiants Auth0 et adapter le comportement de l’outil à vos besoins. Le Deploy CLI peut être configuré de deux façons :

1. Utiliser le fichier de configuration (config.json).
2. Définir des variables d’environnement.

​

Fichier de configuration

Un fichier JSON autonome peut être utilisé pour configurer Deploy CLI. Ce fichier se trouve habituellement dans le répertoire racine de votre projet et doit être nommé config.json.

​

Exemple

{
  "AUTH0_DOMAIN": "<YOUR_TENANT_DOMAIN>",
  "AUTH0_CLIENT_ID": "{yourClientId}",
  "AUTH0_ALLOW_DELETE": false
}

Il n’est pas recommandé d’intégrer des identifiants en dur, car ils risquent d’être divulgués si ce fichier est un jour validé dans un système public de contrôle de version. Pour atténuer ce risque, il est recommandé de transmettre les identifiants sous forme de variables d’environnement.

​

Variables d’environnement

Par défaut, le Deploy CLI utilise les variables d’environnement, ce qui permet de transmettre des informations d’authentification et d’autres paramètres à l’outil sans devoir les publier dans le fichier config.json. Les variables d’environnement peuvent servir à compléter le fichier config.json ou à le remplacer entièrement, selon les besoins du projet.

Les valeurs de configuration non primitives comme AUTH0_KEYWORD_REPLACE_MAPPINGS et AUTH0_EXCLUDED peuvent aussi être transmises au moyen de variables d’environnement, à condition d’être correctement sérialisées en JSON.

Pour désactiver l’utilisation des variables d’environnement pour les commandes import ou export, transmettez l’argument --env=false.

​

Exemples

​

Déployer une configuration pour les formats YAML sans fichier config.json

$ export AUTH0_DOMAIN={yourDomain}
$ export AUTH0_CLIENT_ID={yourClientId}
$ export AUTH0_CLIENT_SECRET={yourClientSecret}
$ a0deploy import --input_file=local/tenant.yaml

​

Désactiver la lecture des variables d’environnement

$ a0deploy export -c=config.json --format=yaml --output_folder=local --env=false

​

Valeurs de configuration non primitives

$ export AUTH0_EXCLUDED='["actions","organizations"]'
$ export AUTH0_KEYWORD_REPLACE_MAPPINGS='{"ENVIRONMENT":"dev"}'
$ a0deploy export -c=config.json --format=yaml --output_folder=local

​

Propriétés de configuration disponibles

​

AUTH0_DOMAIN

String. Le domaine du tenant Auth0 cible.

​

AUTH0_CLIENT_ID

String. L’ID de l’application Auth0 spécifiée utilisée pour envoyer des requêtes à l’API.

​

AUTH0_CLIENT_SECRET

String. Le secret de l’application Auth0 spécifiée servant à effectuer des requêtes API.

​

AUTH0_ACCESS_TOKEN

String. Jeton d’accès de courte durée permettant d’accéder à la Management API depuis l’application Auth0 désignée. Peut être utilisé à la place de la combinaison ID client et secret client.

​

AUTH0_CLIENT_SIGNING_KEY_PATH

String. Chemin d’accès à la clé privée utilisée par le client pour l’authentification JWT avec clé privée. Chemin relatif au répertoire de travail. Voir aussi AUTH0_CLIENT_SIGNING_ALGORITHM pour préciser l’algorithme de signature.

​

AUTH0_CLIENT_SIGNING_ALGORITHM

String. Indique les algorithmes de signature JWT utilisés par le client pour l’authentification par JWT avec clé privée. Utilisé uniquement en combinaison avec AUTH0_CLIENT_SIGNING_KEY_PATH.

Valeurs acceptées : RS256, RS384, PS256.

​

AUTH0_ALLOW_DELETE

Booléen. Si elle est activée, cette option permet à l’outil de supprimer des ressources. Par défaut : false.

​

AUTH0_EXCLUDED

Tableau de chaînes de caractères. Exclut entièrement certains types de ressources de la gestion, dans les deux sens. Pour en savoir plus, consultez Exclure des ressources de la gestion.

Ne peut pas être utilisé simultanément avec AUTH0_INCLUDED_ONLY.

Valeurs possibles : actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers.

​

Exemple

{
  "AUTH0_EXCLUDED": ["organizations", "connections", "hooks"]
}

​

AUTH0_INCLUDED_ONLY

Tableau de chaînes de caractères. Indique quels types de ressources gérer dans les deux sens. Pour en savoir plus, consultez Exclure des ressources de la gestion.

Ne peut pas être utilisé en même temps que AUTH0_EXCLUDED.

Valeurs possibles : actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers.

​

Exemple

{
  "AUTH0_INCLUDED_ONLY": ["clients", "connections", "tenant", "branding"]
}

​

AUTH0_KEYWORD_REPLACE_MAPPINGS

Mappage de mots-clés précis permettant le remplacement dynamique. Pour en savoir plus, consultez Remplacement de mots-clés.

​

Exemple

{
  "ENVIRONMENT": "DEV",
  "ALLOWED_ORIGINS": ["https://dev.test-site.com", "localhost"]
}

​

AUTH0_PRESERVE_KEYWORDS

Booléen. Lorsqu’elle est activée, cette option tente de conserver les marqueurs de remplacement de mots-clés dans les fichiers de ressources locaux pendant l’exportation. Sinon, les valeurs distantes écraseront ces marqueurs de mots-clés ajoutés manuellement.

Cette configuration exige la présence de fichiers de configuration locaux ainsi que de mappages de remplacement de mots-clés définis au moyen de la propriété de configuration AUTH0_KEYWORD_REPLACE_MAPPINGS.

Voir aussi : Préserver les mots-clés lors de l’exportation.

​

AUTH0_EXPORT_IDENTIFIERS

Booléen. Lorsqu’elle est activée, renvoie les identifiants de toutes les ressources. Peut être utile dans certains scénarios de débogage ou de consignation au sein d’un contexte à tenant unique. Par défaut : false.

​

EXCLUDED_PROPS

Permet d’exclure de la gestion les propriétés indésirables.

​

Exemple

{
  "connections": ["options.twilio_token"]
}

​

AUTH0_AUDIENCE

String. Valeur distincte de la valeur audience lors de l’obtention d’un jeton d’accès pour la Management API. Utile lorsque les points de terminaison par défaut de la Management API ne sont pas exposés publiquement.

​

AUTH0_EXCLUDED_RULES

Tableau de chaînes de caractères. Exclut de la gestion des Rules précis par ID. Remarque : cette configuration pourrait faire l’objet d’une dépréciation à l’avenir. Pour en savoir plus, consultez Exclure des ressources de la gestion.

​

AUTH0_EXCLUDED_CLIENTS

Tableau de chaînes de caractères. Exclut de la gestion certains clients selon leur ID. Remarque : cette configuration pourrait faire l’objet d’une dépréciation à l’avenir. Pour en savoir plus, consultez Exclure des ressources de la gestion.

​

AUTH0_EXCLUDED_DATABASES

Tableau de chaînes de caractères. Exclut de la gestion certaines bases de données selon leur ID. Remarque : cette configuration pourrait faire l’objet d’une dépréciation à l’avenir. Pour en savoir plus, consultez Exclure des ressources de la gestion.

​

AUTH0_EXCLUDED_CONNECTIONS

Tableau de chaînes de caractères. Exclut de la gestion certaines connexions en fonction de leur ID. Remarque : cette configuration pourrait faire l’objet d’une dépréciation à l’avenir. Pour en savoir plus, consultez Exclure des ressources de la gestion.

​

AUTH0_EXCLUDED_RESOURCE_SERVERS

Tableau de chaînes de caractères. Exclut de la gestion certains serveurs de ressources selon leur ID. Remarque : cette configuration pourrait faire l’objet d’une dépréciation à l’avenir. Pour en savoir plus, consultez Exclure des ressources de la gestion.