> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.generaltranslation.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurer l’outil Deploy CLI

> Découvrez comment configurer l’outil Auth0 Deploy CLI en fonction de vos besoins.

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.

<div id="configuration-file">
  ## Configuration du fichier
</div>

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`.

### Exemple

```javascript lines theme={null}
{
  "AUTH0_DOMAIN": "<YOUR_TENANT_DOMAIN>",
  "AUTH0_CLIENT_ID": "{yourClientId}",
  "AUTH0_ALLOW_DELETE": false
}
```

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  Le codage en dur d’identifiants n’est pas recommandé, et vous risquez une fuite si ce fichier est transmis à un système de contrôle de version publique. Pour limiter le risque, il est fortement conseillé de transmettre les identifiants en tant que [variables d’environnement](#environment-variables).
</Callout>

<div id="environment-variables">
  ## Variables d’environnement
</div>

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`.

<div id="examples">
  ### Exemples
</div>

<div id="deploying-configuration-for-yaml-formats-without-a-configjson-file">
  #### Déployer la configuration pour les formats YAML sans fichier config.json
</div>

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

<div id="disable-environment-variable-ingestion">
  #### Désactiver l’ingestion de variables d’environnement
</div>

```php lines theme={null}
$ a0deploy export -c=config.json --format=yaml --output_folder=local --env=false
```

<div id="non-primitive-configuration-values">
  #### Valeurs de configuration non primitives
</div>

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

<div id="available-configuration-properties">
  ## Propriétés de configuration disponibles
</div>

<div id="auth0_domain">
  ### AUTH0\_DOMAIN
</div>

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

<div id="auth0_client_id">
  ### AUTH0\_CLIENT\_ID
</div>

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

<div id="auth0_client_secret">
  ### AUTH0\_CLIENT\_SECRET
</div>

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

<div id="auth0_access_token">
  ### AUTH0\_ACCESS\_TOKEN
</div>

Chaîne de caractères. Jeton d’accès de courte durée pour <Tooltip href="/docs/fr-CA/fr-ca/glossary?term=management-api" tip="Management API
Un produit permettant aux clients d’effectuer des tâches administratives." cta="Voir le glossaire">Management API</Tooltip> à partir de l’application Auth0 désignée. Peut être utilisé en remplacement de la combinaison ID et secret client.

<div id="auth0_client_signing_key_path">
  ### AUTH0\_CLIENT\_SIGNING\_KEY\_PATH
</div>

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 <Tooltip href="/docs/fr-CA/fr-ca/glossary?term=json-web-token" tip="Jeton Web JSON (JWT)
Format standard de jeton d’ID (et souvent de jeton d’accès) utilisé pour représenter en toute sécurité des demandes entre deux parties." cta="Voir le glossaire">JWT</Tooltip>. Chemin d’accès relatif au répertoire de travail. Notez également `AUTH0_CLIENT_SIGNING_ALGORITHM` pour spécifier l’algorithme de signature.

<div id="auth0_client_signing_algorithm">
  ### AUTH0\_CLIENT\_SIGNING\_ALGORITHM
</div>

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`.

<div id="auth0_allow_delete">
  ### AUTH0\_ALLOW\_DELETE
</div>

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

<div id="auth0_excluded">
  ### AUTH0\_EXCLUDED
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

Ne peut pas être utilisé simultanément avec [AUTH0\_INCLUDED\_ONLY](#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`.

<div id="example">
  #### Exemple
</div>

```json lines theme={null}
{
  "AUTH0_EXCLUDED": ["organizations", "connections", "hooks"]
}
```

<div id="auth0_included_only">
  ### AUTH0\_INCLUDED\_ONLY
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

Ne peut pas être utilisé simultanément avec [AUTH0\_EXCLUDED](#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`.

<div id="example">
  #### Exemple
</div>

```json lines theme={null}
{
  "AUTH0_INCLUDED_ONLY": ["clients", "connections", "tenant", "branding"]
}
```

<div id="auth0_keyword_replace_mappings">
  ### AUTH0\_KEYWORD\_REPLACE\_MAPPINGS
</div>

Cartographie de mots-clés spécifiques au remplacement dynamique des installations. Pour en savoir plus, lisez [Remplacement des mots-clés](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/keyword-replacement).

<div id="example">
  #### Exemple
</div>

```javascript lines theme={null}
{
  "ENVIRONMENT": "DEV",
  "ALLOWED_ORIGINS": ["https://dev.test-site.com", "localhost"]
}
```

<div id="auth0_preserve_keywords">
  ### AUTH0\_PRESERVE\_KEYWORDS
</div>

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](https://auth0.com/docs/deploy-monitor/deploy-cli-tool/keyword-replacement#preserve-keywords-on-export).

<div id="auth0_export_identifiers">
  ### AUTH0\_EXPORT\_IDENTIFIERS
</div>

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`.

<div id="excluded_props">
  ### EXCLUDED\_PROPS
</div>

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

<div id="example">
  #### Exemple
</div>

```javascript lines theme={null}
{
  "connections": ["options.twilio_token"]
}
```

<div id="auth0_audience">
  ### AUTH0\_AUDIENCE
</div>

Chaîne de caractères. Sépare la valeur de la valeur d'<Tooltip data-tooltip-id="react-containers-DefinitionTooltip-2" tip="">audience</Tooltip> 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.

<div id="auth0_excluded_rules">
  ### AUTH0\_EXCLUDED\_RULES
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

<div id="auth0_excluded_clients">
  ### AUTH0\_EXCLUDED\_CLIENTS
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

<div id="auth0_excluded_databases">
  ### AUTH0\_EXCLUDED\_DATABASES
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

<div id="auth0_excluded_connections">
  ### AUTH0\_EXCLUDED\_CONNECTIONS
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

<div id="auth0_excluded_resource_servers">
  ### AUTH0\_EXCLUDED\_RESOURCE\_SERVERS
</div>

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](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).