Configurer l’outil Deploy CLI

La configuration de l’outil Deploy CLI est essentielle pour établir les identifiants Auth0 ainsi que pour modifier généralement le comportement de l’outil en fonction de vos besoins particuliers. Il existe deux façons de configurer l’outil Deploy CLI :

1. Utiliser le fichier de configuration (config.json).

2. Définissez les variables d’environnement.

Un fichier JSON autonome peut être utilisé pour configurer l’outil Deploy CLI. Ce fichier réside généralement dans le répertoire racine de votre projet et doit être nommé config.json.

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

Par défaut, l’outil Deploy CLI intègre les variables d’environnement, ce qui permet de transmettre des identifiants et d’autres configurations à l’outil sans avoir besoin de publier dans le fichier config.json. Les variables d’environnement peuvent être utilisées pour augmenter le fichier config.json ou le remplacer complètement en fonction des besoins du projet.

Les valeurs de configuration non primitives telles que AUTH0_KEYWORD_REPLACE_MAPPINGS et AUTH0_EXCLUDED peuvent également être transmises via des variables d’environnement à condition que ces valeurs soient correctement sérialisées en JSON.

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

$ export AUTH0_DOMAIN=<YOUR_AUTH0_DOMAIN>
$ export AUTH0_CLIENT_ID=<YOUR_CLIENT_ID>
$ export AUTH0_CLIENT_SECRET=<YOUR_CLIENT_SECRET>
$ a0deploy import --input_file=local/tenant.yaml

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

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

Chaîne de caractères. Domaine du locataire Auth0 cible.

Chaîne de caractères. L’ID de l’application Auth0 désignée utilisée pour effectuer des requêtes API.

Chaîne de caractères. Le secret de l’application Auth0 désignée utilisée pour effectuer des requêtes API.

Chaîne de caractères. Jeton d’accès de courte durée pour Management API à partir de l’application Auth0 désignée. Peut être utilisé en remplacement de la combinaison ID et secret client.

Chaîne de caractères. Le chemin d’accès à la clé privée utilisée par le client pour faciliter l’authentification par clé privée JWT. Chemin d’accès relatif au répertoire de travail. Notez également AUTH0_CLIENT_SIGNING_ALGORITHM pour spécifier l’algorithme de signature.

Chaîne de caractères. Spécifie les algorithmes de signature JWT utilisés par le client pour faciliter l’authentification par clé privée JWT. Utilisé seulement en combinaison avec AUTH0_CLIENT_SIGNING_KEY_PATH.

Valeurs acceptées : RS256, RS384, PS256.

Valeur booléenne. Lorsqu’elle est activée, permettra à l’outil de supprimer des ressources. Valeur par défaut : false.

Tableau de chaînes de caractères. Exclut des types de ressources entiers de la gestion bidirectionnelle. Pour en savoir plus, lisez Exclure les 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.

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

Tableau de chaînes de caractères. Spécifie les types de ressources à gérer de manière bidirectionnelle. Pour en savoir plus, lisez Exclure les ressources de la gestion.

Ne peut pas être utilisé simultanément avec 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.

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

Cartographie de mots-clés spécifiques au remplacement dynamique des installations. Pour en savoir plus, lisez Remplacement des mots-clés.

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

Valeur booléenne. Lorsqu’elle est activée, elle tentera de conserver les marqueurs de remplacement de mots-clés dans les fichiers de ressources locales lors de l’exportation. Sinon, les valeurs distantes écraseront ces marqueurs de mots-clés placés manuellement.

Cette configuration nécessite la présence de fichiers de configuration locaux et de mappages de remplacement de mots-clés définis par le biais de la propriété de configuration AUTH0_KEYWORD_REPLACE_MAPPINGS .

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

Valeur booléenne. Lorsqu’elle est activée, elle renverra les identifiants de toutes les ressources. Peut être utile pour certains scénarios de débogage ou de tenue d’enregistrements dans un contexte à locataire unique. Valeur par défaut : false.

Offre la possibilité d’exclure de la gestion toutes les propriétés indésirables.

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

Chaîne de caractères. Sépare la valeur de la valeur d'audience lors de la récupération d’un jeton d’accès pour Management API. Utile lorsque les points de terminaison de Management API par défaut ne sont pas exposés publiquement.

Tableau de chaînes de caractères. Exclut la gestion de règles spécifiques par identifiant. Remarque : Cette configuration pourrait être sujette à une dépréciation à l’avenir. Pour en savoir plus, lisez Exclure les ressources de la gestion.

Tableau de chaînes de caractères. Exclut la gestion de clients spécifiques par identifiant. Remarque : Cette configuration pourrait être sujette à une dépréciation à l’avenir. Pour en savoir plus, lisez Exclure les ressources de la gestion.

Tableau de chaînes de caractères. Exclut la gestion de bases de données spécifiques par identifiant. Remarque : Cette configuration pourrait être sujette à une dépréciation à l’avenir. Pour en savoir plus, lisez Exclure les ressources de la gestion.

Tableau de chaînes de caractères. Exclut la gestion des connexions spécifiques par identifiant. Remarque : Cette configuration pourrait être sujette à une dépréciation à l’avenir. Pour en savoir plus, lisez Exclure les ressources de la gestion.

Tableau de chaînes de caractères. Exclut la gestion de serveurs de ressources spécifiques par identifiant. Remarque : Cette configuration pourrait être sujette à une dépréciation à l’avenir. Pour en savoir plus, lisez Exclure les ressources de la gestion.