開始前に
Auth0 テナントを設定します。
CLI コマンドの完全なリファレンスと詳細な利用方法については、Auth0 CLI Reference Documentation をご覧ください。
主な機能
- 対話形式の管理: コマンドラインから Auth0 リソースを作成、更新、管理
- 認証サポート: ユーザーログインや machine-to-machine の資格情報を含む、複数の認証方法に対応
- リソース管理: アプリケーション、API、接続、ユーザーなどに対する完全な CRUD 操作
- クロスプラットフォーム: macOS、Linux、Windows で利用可能
- JSON 出力: スクリプト作成や自動化に適した機械可読な出力
利用例
Auth0 CLIは、次のような用途に最適です。- 開発ワークフロー: 開発中にAuth0リソースをすばやくセットアップして設定する
- テスト: 自動テスト用のテストアプリケーションやユーザーを作成する
- デバッグ: Auth0の設定をリアルタイムで確認・変更する
- スクリプト作成: シェルスクリプトを使って繰り返し作業を自動化する
- CI/CD連携: Auth0の設定をデプロイパイプラインに組み込む
他のツールとの比較
Auth0 CLI と Deploy CLI
- Auth0 CLI: 対話形式で、コマンドごとにリソースを管理します。開発や一時的な作業に最適です。
- Deploy CLI: 宣言型で、設定ファイルベースのテナント管理を行います。環境をまたいでテナント全体の構成を管理するのに最適です。
Auth0 CLI と Terraform Provider
- Auth0 CLI: 変更をすぐに反映するための命令型コマンド。状態管理は行いません。
- Terraform Provider: 状態を追跡する宣言型のインフラストラクチャ as code。Production 環境のインフラストラクチャ管理に最適です。
Auth0 CLI のインストール
macOS
Homebrew を使って設定します。Linux
Windows
Scoop を使って設定します:認証
Auth0 CLI を使用するには、認証が必要です。次のコマンドを実行すると、Auth0 アカウントにログインするためのブラウザーウィンドウが開きます。よく使うコマンド
アプリケーションの管理
APIの管理
ユーザー管理
テナント設定の管理
スクリプトでの使用
Auth0 CLI は、スクリプトで簡単にパースできる JSON 出力をサポートしています。Agent Modeの使用
Agent Modeを有効にすると、AIエージェントが人の介在なしにCLIを操作する際も、動作が予測可能になります。--agent-modeフラグまたはAUTH0_AGENT_MODE環境変数で有効にできます。
--json-compactを指定すると、余分な空白を省いた同じデータを取得できます。
auth0 logs tail などのストリーミングコマンドは、Agent Modeでは常にコンパクト形式で出力されます。
コマンド体系を把握する
エージェントは、--help を1階層ずつたどらなくても、1回の呼び出しで CLI 全体を把握できます:
--detailed を付けると、各コマンドのフラグ、引数、デフォルト値、認証の要否も出力に含まれます。
送信前にペイロードの構造を確認する
--schema を指定すると、コマンドが受け付けるリクエストのペイロードを OpenAPI 仕様に基づいて出力します。
--data はペイロードを単一の JSON オブジェクトとして送信し、リクエストが API に届く前にローカルで検証します。
構造化エラー
Agent Mode では、失敗時には常にプレーンテキストのメッセージではなく、JSON 形式のエラーエンベロープが返されます。error オブジェクトには以下が含まれます。
code:失敗の分類です。取り得る値はusage、auth、validation、not_found、rate_limit、conflict、network、api、unknown(より具体的な分類に該当しない場合のフォールバック) の 9 種類です。reason:より詳細な失敗の分類です。reasonの取り得る値はこれですべてではなく、CLI がより細かな失敗情報に対応するにつれて増えていきます。そのため、codeは安定した仕様として、reasonは補足的なコンテキストとして扱ってください。details:ペイロードがバリデーションに失敗した場合の、フィールド単位の情報です。
ターミナルからドキュメントを検索する
auth0 docs search を使用すると、ターミナルから離れることなく、認証も不要でAuth0の公開ドキュメントを検索できます:
ドキュメントとサポート
完全なドキュメント、コマンドリファレンス、使用例については、以下をご覧ください。次のステップ
Deploy CLI
Deploy CLI を使用したテナント設定の管理について学ぶ
Terraform Provider
Terraform による infrastructure-as-code を確認する
Management API
Auth0 Management API に直接アクセスする