Configurer le Deploy CLI

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

La configuration du Deploy CLI est essentielle pour définir les identifiants Auth0 et, plus généralement, pour adapter le comportement de l’outil à vos besoins. Le Deploy CLI peut être configuré de deux façons :

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

​

Fichier de configuration

Vous pouvez utiliser un fichier JSON distinct pour configurer Deploy CLI. Ce fichier se trouve généralement 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é de coder des identifiants en dur, car il y a un risque de divulgation de secrets si ce fichier est un jour validé dans un système de contrôle de version public. Pour réduire ce risque, il est recommandé de transmettre les identifiants sous forme de variables d’environnement.

​

Variables d’environnement

Par défaut, Deploy CLI lit les variables d’environnement, ce qui permet de transmettre des identifiants et d’autres paramètres de configuration à l’outil sans avoir à les publier dans le fichier config.json. Les variables d’environnement peuvent soit servir à compléter le fichier config.json, soit 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 qu’elles soient correctement sérialisées au format JSON.

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

​

Exemples

​

Déployer la 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 prise en compte 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 locataire Auth0 ciblé.

​

AUTH0_CLIENT_ID

String. Identifiant de l’application Auth0 spécifiée utilisé pour effectuer des requêtes API.

​

AUTH0_CLIENT_SECRET

Chaîne. Secret de l’application Auth0 spécifiée, utilisé pour effectuer des requêtes à l’API.

​

AUTH0_ACCESS_TOKEN

Chaîne. jeton d’accès de courte durée pour le Management API de l’application Auth0 désignée. Peut être utilisé à la place de la combinaison ID client et secret client.

​

AUTH0_CLIENT_SIGNING_KEY_PATH

Chaîne. Chemin vers la clé privée utilisée par l’application pour l’authentification par clé privée JWT. Chemin relatif au répertoire de travail. Consultez également AUTH0_CLIENT_SIGNING_ALGORITHM pour préciser l’algorithme de signature.

​

AUTH0_CLIENT_SIGNING_ALGORITHM

Chaîne de caractères. Indique les algorithmes de signature JWT utilisés par l’application pour l’authentification Private Key JWT. Utilisé uniquement avec AUTH0_CLIENT_SIGNING_KEY_PATH.

Valeurs acceptées : RS256, RS384, PS256.

​

AUTH0_ALLOW_DELETE

Booléen. Si cette option est activée, l’outil peut supprimer des ressources. Valeur par défaut : false.

​

AUTH0_EXCLUDED

Tableau de chaînes. Exclut des types de ressources entiers de la gestion bidirectionnelle. 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 en mode bidirectionnel. 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

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

​

Exemple

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

​

AUTH0_PRESERVE_KEYWORDS

Valeur booléenne. Lorsqu’elle est activée, cette option tente de préserver les marqueurs de remplacement de mots-clés dans les fichiers de ressources locaux pendant l’exportation. Sinon, les valeurs distantes écraseront ces marqueurs placé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

Valeur booléenne. 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 dans un contexte de locataire unique. Par défaut : false.

​

EXCLUDED_PROPS

Permet d’exclure de la gestion les propriétés non souhaitées.

​

Exemple

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

​

AUTH0_AUDIENCE

String. Valeur distincte de la valeur audience utilisée 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. Exclut de la gestion des Rules spécifiques selon leur identifiant. 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 la gestion d’applications précises 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. Exclut de la gestion certaines bases de données par id. Remarque : cette configuration pourrait faire l’objet d’une dépréciation ultérieurement. 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 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_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.