Skip to main content

始める前に

Set up an Auth0 Tenant.
Auth0 Deploy CLI は、Auth0 テナントの設定管理に役立つツールです。スタンドアロンの CLI として、または Node.js モジュールとして、開発ワークフローに組み込めます。詳細は 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.

​
主な特長

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

​
はじめに

このガイドでは、Deploy CLI をスタンドアロンの CLI として使用開始するための手順を説明します。Deploy CLI を実行する前に、主に次の 3 つの手順が必要です。
  1. 専用の Auth0 アプリケーションを作成する
  2. Deploy CLI を設定する
  3. Deploy CLI を実行する
このツールは Auth0 テナントに破壊的な変更を加える可能性があります。本番環境で使用する前に、AUTH0_ALLOW_DELETE configuration について十分に理解し、開発用テナントでテストすることを推奨します。

​
Deploy CLI をインストールする

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

​
専用の Auth0アプリケーションを作成する

Deploy CLI からを呼び出せるようにするには、ツールが使用する専用の 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セクションを参照してください。
    3. Authorizeを選択します。
Deploy CLI 自身のクライアントは、破壊的な変更が行われる可能性を防ぐため、直接設定することはできません。

​
クライアントのスコープ

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

​
Deploy CLI を設定する

Deploy CLI は、次の 2 つの方法で設定できます。
  1. 設定ファイル (config.json) を使用する。
  2. 環境変数を設定する。
どちらか一方、または両方を選ぶかは、特定のユースケースや好みによって異なります。詳しくは、Deploy CLI を設定する をご覧ください。 この例では、次の環境変数を設定します。
  • AUTH0_DOMAIN
  • AUTH0_CLIENT_ID
  • AUTH0_CLIENT_SECRET
これらの値は、先ほど作成した専用の Auth0 アプリケーションの 設定 タブで確認できます。

​
Deploy CLI を実行する

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 を参照してください。