メインコンテンツへスキップ

始める前に

Auth0 テナントを設定します。
Auth0 Deploy CLI は、Auth0 テナントの設定を管理するためのツールです。スタンドアロン CLI として、または Node.js モジュールとして、開発ワークフローに組み込めます。 サポートされるリソースタイプ: 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.js モジュールとして、CI/CD ワークフローに組み込めます。

​
はじめに

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

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

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

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

Deploy CLI が を呼び出せるようにするには、ツールの代わりに呼び出しを行う専用の Auth0 アプリケーションを作成する必要があります。
  1. Auth0 Dashboard > Applications > Applications に移動します。
  2. + Create Application を選択します。
    1. わかりやすい名前 (「Deploy CLI」など) を付けます。
    2. Application Type で Machine to Machine Applications を選択します。
    3. Create を選択します。
  3. Authorize Machine to Machine Application ビューに切り替えます。
    1. Auth0 Management API を選択します。
    2. 管理するリソースに応じた適切な権限を選択します。詳細については、クライアントのスコープ セクションを参照してください。
    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 アプリケーションの Settings タブで確認できます。

​
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 使用できるフラグとオプションの一覧については、CLI として使用するを参照してください。