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

> Auth0 Deploy CLI を使用してテナントの設定とリソースを管理し、開発ワークフローに統合する方法を学びます。

<Card title="始める前に">
  Set up an [Auth0 Tenant](https://manage.auth0.com/).
</Card>

Auth0 Deploy CLI は、Auth0 テナントの設定管理に役立つツールです。スタンドアロンの CLI として、または Node.js モジュールとして、開発ワークフローに組み込めます。詳細は [Auth0 Deploy CLI](https://github.com/auth0/auth0-deploy-cli) をご覧ください。

サポート対象のリソースタイプ: `actions`, `branding`, `client grants`, `clients (applications)`, `connections`, `custom domains`, `email templates`, `emails`, `grants`, `guardian`, `hook secrets`, `log streams`, `migrations`, `organizations`, `pages`, `prompts`, `resource servers (APIs)`, `roles`, `tenant settings`, `themes`.

<div id="highlights">
  ## 主な特長
</div>

* **マルチ環境対応:** フィーチャーブランチから本番環境まで、アプリケーションの Auth0 連携をテストできるように設計されています。
* **キーワード置換:** 動的なキーワード置換により、すべての環境でリソース設定を共通化できます。
* **柔軟性:** CLI または Node モジュールとして、CI/CD ワークフローに組み込めます。

<div id="get-started">
  ## はじめに
</div>

このガイドでは、Deploy CLI をスタンドアロンの CLI として使用開始するための手順を説明します。Deploy CLI を実行する前に、主に次の 3 つの手順が必要です。

1. [専用の Auth0 アプリケーションを作成する](#create-a-dedicated-auth0-application)
2. [Deploy CLI を設定する](#configure-the-deploy-cli)
3. [Deploy CLI を実行する](#call-the-deploy-cli)

<Warning>
  このツールは Auth0 テナントに破壊的な変更を加える可能性があります。本番環境で使用する前に、[AUTH0\_ALLOW\_DELETE configuration](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli#auth0_allow_delete) について十分に理解し、開発用テナントでテストすることを推奨します。
</Warning>

<div id="install-the-deploy-cli">
  ### Deploy CLI をインストールする
</div>

スタンドアロンのコマンドラインツールとして実行するには、次のコマンドを実行します。

`npm install -g auth0-deploy-cli`

<div id="create-a-dedicated-auth0-application">
  ### 専用の Auth0アプリケーションを作成する
</div>

Deploy CLI から<Tooltip tip="Management API: お客様が管理タスクを実行できるようにする製品。" cta="用語集を見る" href="/docs/ja-jp/glossary?term=Management+API">Management API</Tooltip>を呼び出せるようにするには、ツールが使用する専用の Auth0アプリケーションを作成する必要があります。

1. **Auth0 Dashboard > アプリケーション > アプリケーション**に移動します。
2. **+ Create Application**を選択します。

   1. わかりやすい名前 (「Deploy CLI」など) を付けます。
   2. **アプリケーションの種類**で**Machine to Machine Applications**を選択します。
   3. **Create**を選択します。
3. **Authorize Machine to Machine Application**ビューに切り替えます。

   1. **Auth0 Management API**を選択します。
   2. 管理するリソースに応じて適切な権限を選択します。詳しくは[Client Scopes](#client-scopes)セクションを参照してください。
   3. **Authorize**を選択します。

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  Deploy CLI 自身のクライアントは、[破壊的な変更が行われる可能性を防ぐため](/docs/ja-jp/deploy-monitor/deploy-cli-tool/resource-specific-documentation#client-grants)、直接設定することはできません。
</Callout>

<div id="client-scopes">
  #### クライアントのスコープ
</div>

Deploy CLI で Management の操作を実行できるようにするには、対象のアプリケーションにスコープを付与する必要があります。

最小権限の原則に従い、付与された権限の範囲内で動作します。`read:clients` を選択する必要がありますが、Management の管理対象にあるすべてのリソースタイプについて、`read:*`、`create:*`、`update:*` 権限を選択することを推奨します。削除を有効にするには、`delete:*` スコープが必要です。

<div id="configure-the-deploy-cli">
  ### Deploy CLI を設定する
</div>

Deploy CLI は、次の 2 つの方法で設定できます。

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

どちらか一方、または両方を選ぶかは、特定のユースケースや好みによって異なります。詳しくは、[Deploy CLI を設定する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli) をご覧ください。

この例では、次の環境変数を設定します。

* `AUTH0_DOMAIN`
* `AUTH0_CLIENT_ID`
* `AUTH0_CLIENT_SECRET`

これらの値は、先ほど作成した専用の Auth0 アプリケーションの **設定** タブで確認できます。

<div id="call-the-deploy-cli">
  ### Deploy CLI を実行する
</div>

Deploy CLI の `export` コマンドは、次のコマンドで実行できます。

`a0deploy export --format=yaml --output_folder=local`

処理が完了したら、ローカルのディレクトリに生成されたリソース設定ファイルを確認してください。次に、`import` コマンドを実行して、ローカルマシンから Auth0 テナントに設定を反映します。

`a0deploy import --config_file=config.json --input_file local/tenant.yaml`

フラグとオプションの一覧については、[Use as CLI](/docs/ja-jp/deploy-monitor/deploy-cli-tool/use-as-a-cli) を参照してください。