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

文字列。API リクエストの実行に使用される、指定の Auth0 アプリケーションの ID。

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

文字列。API リクエストの実行に使用される、指定された Auth0 アプリケーションのシークレット。

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

文字列。指定された Auth0 アプリケーションから <Tooltip tip="アクセストークン: API へのアクセスに使用される、不透明な文字列または JWT 形式の認可資格情報。" cta="用語集を表示" href="/ja/docs/glossary?term=access+token">アクセストークン</Tooltip> にアクセスするための、短期間有効な <Tooltip tip="アクセストークン: API へのアクセスに使用される、不透明な文字列または JWT 形式の認可資格情報。" cta="用語集を表示" href="/ja/docs/glossary?term=Management+API">Management API</Tooltip> です。<Tooltip tip="クライアントID: Auth0 から登録済みリソースに付与される識別値。" cta="用語集を表示" href="/ja/docs/glossary?term=client+ID">クライアントID</Tooltip> と <Tooltip tip="クライアントID: Auth0 から登録済みリソースに付与される識別値。" cta="用語集を表示" href="/ja/docs/glossary?term=client+secret">クライアントシークレット</Tooltip> の組み合わせの代わりに使用できます。

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

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

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

文字列。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>

文字列の配列。リソースタイプ全体を双方向の管理対象から除外します。詳細は、[リソースを管理対象から除外する](/ja/docs/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>

文字列の配列です。双方向で管理するリソースタイプを指定します。詳細は、[管理対象からリソースを除外する](/ja/docs/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>

特定のキーワードの動的置換に使用するマッピングです。詳細については、[Keyword Replacement](/ja/docs/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` 設定プロパティでキーワード置換マッピングが定義されている必要があります。

関連情報: [エクスポート時にキーワードを保持する](/ja/docs/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>

文字列。Management API のアクセストークンを取得する際に使用する、<Tooltip tip="対象者: 発行されたトークンの対象者を一意に識別する識別子です。トークン内では aud という名前で表され、その値には、IDトークンの場合はアプリケーション（クライアントID）、アクセストークンの場合は API（API Identifier）の ID が含まれます。" cta="用語集を表示" href="/ja/docs/glossary?term=audience">オーディエンス</Tooltip> の値とは別の値です。既定の Management API エンドポイントが一般公開されていない場合に役立ちます。

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

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

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

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

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

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

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

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

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

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