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

> Auth0 Deploy CLI を設定して、用途に合わせてツールを調整する方法を学びます。

# Deploy CLI を設定する

Deploy CLI の設定は、Auth0 の認証情報を設定し、ツールの動作をニーズに合わせて調整するために重要です。Deploy CLI の設定方法は 2 つあります。

1. 設定ファイル (`config.json`) を使用します。
2. 環境変数を設定します。

<div id="configuration-file">
  ## 設定ファイル
</div>

Deploy CLI の設定には、単一の JSON ファイルを使用できます。このファイルは通常、プロジェクトのルートディレクトリに置かれ、ファイル名は `config.json` にする必要があります。

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

```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">
  認証情報をコードにハードコーディングすることは推奨されません。これらの情報は、このファイルが公開されたバージョン管理システムにコミットされると漏えいするおそれがあります。このリスクを軽減するため、ベストプラクティスとして、認証情報は[環境変数](#environment-variables)で渡してください。
</Callout>

<div id="environment-variables">
  ## 環境変数
</div>

既定では、Deploy CLI は環境変数を読み込むため、認証情報やその他の設定を `config.json` ファイルに記載しなくてもツールに渡せます。環境変数は、プロジェクトの要件に応じて `config.json` ファイルを補完することも、完全に置き換えることもできます。

`AUTH0_KEYWORD_REPLACE_MAPPINGS` や `AUTH0_EXCLUDED` のような非プリミティブな設定値も、値が適切にシリアライズされた JSON であれば、環境変数経由で渡すことができます。

`import` または `export` コマンドで環境変数の読み込みを無効にするには、`--env=false` 引数を指定します。

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

<div id="deploying-configuration-for-yaml-formats-without-a-configjson-file">
  #### config.json ファイルを含まない YAML 形式の設定のデプロイ
</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">
  #### 環境変数の読み込みを無効にする
</div>

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

<div id="non-primitive-configuration-values">
  #### プリミティブ型以外の設定値
</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">
  ## 利用可能な設定プロパティ
</div>

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

文字列。対象となる Auth0 テナントのドメイン。

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

String. APIリクエストの送信に使用する、指定されたAuth0 applicationのIDです。

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

String。APIリクエストの送信に使用する、指定されたAuth0 applicationのシークレットです。

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

String. 指定されたAuth0 applicationから<Tooltip tip="Access Token: APIへのアクセスに使用される、opaque stringまたはJWT形式のAuthorization認証情報。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=access+token">access token</Tooltip>として<Tooltip tip="Access Token: APIへのアクセスに使用される、opaque stringまたはJWT形式のAuthorization認証情報。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=Management+API">Management API</Tooltip>にアクセスするための短期間有効なトークンです。<Tooltip tip="Client ID: Auth0から登録済みリソースに付与される識別値。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=client+ID">client ID</Tooltip>と<Tooltip tip="Client ID: Auth0から登録済みリソースに付与される識別値。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=client+secret">client secret</Tooltip>の組み合わせの代わりに使用できます。

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

String。Private Key <Tooltip tip="JSON Web Token (JWT): 2者間でclaimsを安全にやり取りするために使用される標準的なID Token形式（多くの場合、access tokenの形式としても使用されます）。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=JWT">JWT</Tooltip>認証を行う際にクライアントが使用する秘密鍵へのパスです。作業ディレクトリからの相対パスで指定します。<Tooltip tip="Signing Algorithm: トークンが改ざんされていないことを保証するために、トークンにデジタル署名する際に使用するアルゴリズムです。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=signing+algorithm">署名アルゴリズム</Tooltip>を指定するには、`AUTH0_CLIENT_SIGNING_ALGORITHM` も参照してください。

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

String型。Private Key JWT認証を行う際に、クライアントが使用するJWT署名アルゴリズムを指定します。`AUTH0_CLIENT_SIGNING_KEY_PATH`と組み合わせて使用する場合にのみ使われます。

使用可能な値: `RS256`, `RS384`, `PS256`。

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

ブール値。有効にすると、このツールでリソースを削除できるようになります。既定値: `false`。

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

文字列の配列。リソースタイプ全体を双方向の管理対象から除外します。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management)をご覧ください。

[AUTH0\_INCLUDED\_ONLY](#auth0_included_only) と同時に使用することはできません。

指定可能な値: `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">
  #### 例
</div>

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

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

文字列の配列です。双方向で管理するリソースタイプを指定します。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management)をご覧ください。

[AUTH0\_EXCLUDED](#auth0_excluded)と同時に使用することはできません。

指定可能な値: `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">
  #### 例
</div>

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

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

特定のキーワードを動的に置換するためのマッピングです。詳しくは、[キーワード置換](/docs/ja-jp/deploy-monitor/deploy-cli-tool/keyword-replacement)をご覧ください。

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

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

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

ブール値。有効にすると、エクスポート時にローカルのリソースファイル内のキーワード置換マーカーを保持しようとします。無効の場合、リモートの値で手動配置されたそれらのキーワードマーカーが上書きされます。

この設定では、ローカル設定ファイルが存在し、`AUTH0_KEYWORD_REPLACE_MAPPINGS` 設定プロパティでキーワード置換マッピングが定義されている必要があります。

関連項目: [エクスポート時にキーワードを保持](/docs/ja-jp/deploy-monitor/deploy-cli-tool/keyword-replacement#preserve-keywords-on-export)。

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

ブール値。有効にすると、すべてのリソースの識別子が返されます。単一テナント環境での特定のデバッグや記録保持の用途で役立つ場合があります。デフォルト: `false`。

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

管理対象から不要なプロパティを除外できます。

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

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

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

String。Management API のアクセストークンを取得する際に、<Tooltip tip="Audience: 発行されたトークンの audience の一意の識別子です。トークン内では aud という名前で、その値には ID Token の場合は application（Client ID）、Access Token の場合は API（API Identifier）の ID が含まれます。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=audience">audience</Tooltip> の値とは別の値を指定します。デフォルトの Management API endpoint が公開されていない場合に便利です。

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

文字列の配列です。IDで指定した特定のルールを管理対象から除外します。注: この設定は、将来的に非推奨化される可能性があります。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management) をご覧ください。

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

文字列の配列。IDで指定した特定のクライアントを管理対象から除外します。注: この設定は、将来的に非推奨化される可能性があります。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management)を参照してください。

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

文字列の配列。ID で指定した特定のデータベースを管理対象から除外します。注: この設定は今後、非推奨化される可能性があります。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management) を参照してください。

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

文字列の配列。ID で指定した特定の接続を管理対象から除外します。注: この設定は、今後非推奨になる可能性があります。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management) をご覧ください。

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

文字列の配列。ID で特定の <Tooltip tip="Resource Server: 保護されたリソースをホストするサーバー。リソースサーバーは、保護されたリソースへのリクエストを受け取り、応答します。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=resource+servers">resource servers</Tooltip> の管理を除外します。注: この設定は、将来的に非推奨化される可能性があります。詳しくは、[管理対象からリソースを除外する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/exclude-resources-from-management) を参照してください。