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

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

# Configurer le Deploy CLI

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.

<h2 id="configuration-file">
  Fichier de configuration
</h2>

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

<h3 id="example">
  Exemple
</h3>

```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é 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](#environment-variables).
</Callout>

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

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

<h3 id="examples">
  Exemples
</h3>

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

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

<h4 id="disable-environment-variable-ingestion">
  Désactiver la lecture des variables d’environnement
</h4>

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

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

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

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

<h3 id="auth0_domain">
  AUTH0\_DOMAIN
</h3>

String. Le domaine du tenant Auth0 cible.

<h3 id="auth0_client_id">
  AUTH0\_CLIENT\_ID
</h3>

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

<h3 id="auth0_client_secret">
  AUTH0\_CLIENT\_SECRET
</h3>

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

<h3 id="auth0_access_token">
  AUTH0\_ACCESS\_TOKEN
</h3>

String. <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="/docs/fr-ca/glossary?term=access+token">Jeton d’accès</Tooltip> de courte durée permettant d’accéder à la <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="/docs/fr-ca/glossary?term=Management+API">Management API</Tooltip> depuis 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="/docs/fr-ca/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="/docs/fr-ca/glossary?term=client+secret">secret client</Tooltip>.

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

String. Chemin d’accès à la clé privée utilisée par le client pour l’authentification <Tooltip tip="JSON Web Token (JWT) : format standard de ID Token (et souvent de jeton d’accès) utilisé pour représenter de façon sécurisée des assertions entre deux parties." cta="Voir le glossaire" href="/docs/fr-ca/glossary?term=JWT">JWT</Tooltip> avec clé privée. Chemin relatif au répertoire de travail. Voir aussi `AUTH0_CLIENT_SIGNING_ALGORITHM` pour préciser l’<Tooltip tip="Signing Algorithm : algorithme utilisé pour signer numériquement des jetons afin de garantir que le jeton n’a pas été altéré." cta="Voir le glossaire" href="/docs/fr-ca/glossary?term=signing+algorithm">algorithme de signature</Tooltip>.

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

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

<h3 id="auth0_allow_delete">
  AUTH0\_ALLOW\_DELETE
</h3>

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

<h3 id="auth0_excluded">
  AUTH0\_EXCLUDED
</h3>

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](/docs/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`.

<h4 id="example-2">
  Exemple
</h4>

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

<h3 id="auth0_included_only">
  AUTH0\_INCLUDED\_ONLY
</h3>

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](/docs/fr-ca/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`.

<h4 id="example-3">
  Exemple
</h4>

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

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

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

<h4 id="example-4">
  Exemple
</h4>

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

<h3 id="auth0_preserve_keywords">
  AUTH0\_PRESERVE\_KEYWORDS
</h3>

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

<h3 id="auth0_export_identifiers">
  AUTH0\_EXPORT\_IDENTIFIERS
</h3>

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

<h3 id="excluded_props">
  EXCLUDED\_PROPS
</h3>

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

<h4 id="example-5">
  Exemple
</h4>

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

<h3 id="auth0_audience">
  AUTH0\_AUDIENCE
</h3>

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

<h3 id="auth0_excluded_rules">
  AUTH0\_EXCLUDED\_RULES
</h3>

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

<h3 id="auth0_excluded_clients">
  AUTH0\_EXCLUDED\_CLIENTS
</h3>

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

<h3 id="auth0_excluded_databases">
  AUTH0\_EXCLUDED\_DATABASES
</h3>

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

<h3 id="auth0_excluded_connections">
  AUTH0\_EXCLUDED\_CONNECTIONS
</h3>

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

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

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 requêtes de ressources protégées et y répondent." cta="Voir le glossaire" href="/docs/fr-ca/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](/docs/fr-ca/deploy-monitor/deploy-cli-tool/exclude-resources-from-management).