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

始める前に

Auth0 テナントを設定します。
Auth0 CLI は、Auth0 Management API に直接アクセスできるコマンドラインツールです。ターミナルから Auth0 テナントを管理でき、開発時のインタラクティブな利用を想定して設計されています。また、自動化のためにスクリプトに組み込むこともできます。
CLI コマンドの完全なリファレンスと詳細な使用方法については、Auth0 CLI Reference Documentationを参照してください。

主な機能

  • 対話型管理: コマンドラインから Auth0 リソースを作成、更新、管理
  • 認証サポート: ユーザーログインや M2M クレデンシャルを含む複数の認証方式に対応
  • リソース管理: アプリケーション、API、接続、ユーザーなどに対する完全な CRUD 操作
  • クロスプラットフォーム: macOS、Linux、Windows で利用可能
  • JSON 出力: スクリプトや自動化で扱いやすい機械可読な出力

ユースケース

Auth0 CLI は、次のような用途に最適です。
  • 開発ワークフロー: 開発時に Auth0 リソースをすばやくセットアップして設定する
  • テスト: 自動テスト用のテストアプリケーションやユーザーを作成する
  • デバッグ: Auth0 の設定をリアルタイムで確認および変更する
  • スクリプト作成: シェルスクリプトを使って繰り返しの多いタスクを自動化する
  • CI/CD 統合: Auth0 の設定をデプロイパイプラインに組み込む

他のツールとの比較

Auth0 CLI vs Deploy CLI

  • Auth0 CLI: インタラクティブな、コマンド単位のリソース管理。開発やアドホックな作業に最適です。
  • Deploy CLI: 宣言型で、構成ファイルベースのテナント管理。環境をまたいだテナント全体の構成管理に最適です。

Auth0 CLI と Terraform プロバイダーの比較

  • Auth0 CLI: 変更を即座に適用するための命令型コマンド。state は管理されません。
  • Terraform プロバイダー: state を追跡する宣言型の Infrastructure as Code。本番環境のインフラ管理に最適です。

Auth0 CLI のインストール

macOS

Homebrew を使用して設定します。
brew tap auth0/auth0-cli
brew install auth0

Linux

curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b /usr/local/bin

Windows

Scoop で設定します:
scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git
scoop install auth0
または、GitHub のリリースページから最新バージョンをダウンロードします。

認証

Auth0 CLI を使用するには、認証する必要があります。次のコマンドを実行すると、ブラウザーウィンドウが開き、Auth0 アカウントへのログインを求められます。
auth0 login
マシンツーマシンアプリケーションを使って認証するには、次のコマンドを実行します。
auth0 login --domain <your-domain> --client-id <client-id> --client-secret <client-secret>

よく使うコマンド

アプリケーションの管理

# すべてのアプリケーションを一覧表示する
auth0 apps list

# 新しいアプリケーションを作成する
auth0 apps create --name "My App" --type spa

# アプリケーションの詳細を表示する
auth0 apps show <app-id>

# アプリケーションを更新する
auth0 apps update <app-id> --callbacks "http://localhost:3000/callback"

# アプリケーションを削除する
auth0 apps delete <app-id>

API の管理

# すべてのAPIを一覧表示する
auth0 apis list

# 新しいAPIを作成する
auth0 apis create --name "My API" --identifier "https://my-api.example.com"

# APIの詳細を表示する
auth0 apis show <api-id>

ユーザーの管理

# ユーザーの一覧表示
auth0 users list

# ユーザーの作成
auth0 users create --email "user@example.com" --connection "Username-Password-Authentication"

# ユーザーの詳細表示
auth0 users show <user-id>

# ユーザーの更新
auth0 users update <user-id> --email "newemail@example.com"

テナント設定の管理

# 現在のテナントを表示
auth0 tenants list

# テナント設定を更新
auth0 tenants update

スクリプトで使用する

Auth0 CLI は、スクリプトで簡単に処理できるように JSON 出力をサポートしています。
# アプリケーションの詳細をJSONとして取得する
auth0 apps show <app-id> --json

# アプリを作成して出力をキャプチャする
auth0 apps create --name "My App" --type spa --json > app-details.json

ドキュメントとサポート

完全なドキュメント、コマンドリファレンス、サンプルについては、以下を参照してください。

次のステップ

Deploy CLI

Deploy CLI を使用したテナント構成の管理について詳しく見る

Terraform プロバイダー

Terraform を使用した Infrastructure as Code を詳しく見る

Management API

Auth0 Management API に直接アクセスする