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

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

# Configurer le Deploy CLI

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.

<div id="configuration-file">
  ## Fichier de configuration
</div>

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

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

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  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](#environment-variables).
</Callout>

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

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

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

```bash 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 la prise en compte des variables d’environnement
</div>

```bash wrap 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>

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

String. Le domaine du locataire Auth0 ciblé.

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

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

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

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

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

Chaîne. <Tooltip tip="Jeton d’accès : identifiant d’autorisation, sous la forme d’une chaîne opaque ou d’un JWT, utilisé pour accéder à une API." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=access+token">jeton d’accès</Tooltip> de courte durée pour le <Tooltip tip="Jeton d’accès : identifiant d’autorisation, sous la forme d’une chaîne opaque ou d’un JWT, utilisé pour accéder à une API." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=Management+API">Management API</Tooltip> de l’application Auth0 désignée. Peut être utilisé à la place de la combinaison <Tooltip tip="ID client : valeur d’identification attribuée à votre ressource enregistrée par Auth0." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=client+ID">ID client</Tooltip> et <Tooltip tip="ID client : valeur d’identification attribuée à votre ressource enregistrée par Auth0." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=client+secret">secret client</Tooltip>.

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

Chaîne. Chemin vers la clé privée utilisée par l’application pour l’authentification par clé privée <Tooltip tip="JSON Web Token (JWT) : format standard des ID Token (et souvent des Jetons d’accès), utilisé pour représenter de façon sécurisée des claims entre deux parties." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=JWT">JWT</Tooltip>. Chemin relatif au répertoire de travail. Consultez également `AUTH0_CLIENT_SIGNING_ALGORITHM` pour préciser l’<Tooltip tip="Algorithme de signature : algorithme utilisé pour signer numériquement les jetons afin de garantir qu’ils n’ont pas été altérés." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=signing+algorithm">algorithme de signature</Tooltip>.

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

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

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

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

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

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](/fr-CA/docs/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. Indique quels types de ressources gérer en mode bidirectionnel. Pour en savoir plus, consultez [Exclure des ressources de la gestion](/fr-CA/docs/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).

Ne peut pas être utilisé en même temps que [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>

Correspondance de mots-clés précis permettant leur remplacement dynamique. Pour en savoir plus, consultez [le remplacement de mots-clés](/fr-CA/docs/deploy-monitor/deploy-cli-tool/keyword-replacement).

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

```json 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, 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](/fr-CA/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, 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`.

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

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

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

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

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

String. Valeur distincte de la valeur <Tooltip tip="Audience : identifiant unique du destinataire d’un jeton émis. Nommée aud dans un jeton, sa valeur contient l’ID soit d’une application (ID client) pour un ID Token, soit d’une API (identifiant d’API) pour un Jeton d’accès." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=audience">audience</Tooltip> 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.

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

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

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

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](/fr-CA/docs/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 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](/fr-CA/docs/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 de la gestion certains <Tooltip tip="Serveur de ressources : serveur hébergeant des ressources protégées. Les serveurs de ressources acceptent les demandes de ressources protégées et y répondent." cta="Voir le glossaire" href="/fr-CA/docs/glossary?term=resource+servers">serveurs de ressources</Tooltip> 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](/fr-CA/docs/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).