From 30a8b140e886f5c3a894d7bdfe3a6c4b273be4ac Mon Sep 17 00:00:00 2001 From: Bharath Natarajan Date: Mon, 22 Dec 2025 19:30:04 +0530 Subject: [PATCH 1/2] added a page for auth0 cli --- main/docs.json | 3 +- main/docs/deploy-monitor/auth0-cli.mdx | 187 +++++++++++++++++++ main/docs/deploy-monitor/deploy-cli-tool.mdx | 8 +- main/docs/fr-ca/deploy-monitor/auth0-cli.mdx | 79 ++++++++ 4 files changed, 272 insertions(+), 5 deletions(-) create mode 100644 main/docs/deploy-monitor/auth0-cli.mdx create mode 100644 main/docs/fr-ca/deploy-monitor/auth0-cli.mdx diff --git a/main/docs.json b/main/docs.json index b92800a61..41743d612 100644 --- a/main/docs.json +++ b/main/docs.json @@ -2116,7 +2116,7 @@ }, "docs/deploy-monitor/deploy-checklist", { - "group": "Deploy CLI Tool", + "group": "Deploy CLI", "pages": [ "docs/deploy-monitor/deploy-cli-tool", "docs/deploy-monitor/deploy-cli-tool/use-as-a-cli", @@ -2130,6 +2130,7 @@ "docs/deploy-monitor/deploy-cli-tool/available-resource-configuration-formats" ] }, + "docs/deploy-monitor/auth0-cli", "docs/deploy-monitor/auth0-terraform-provider", "docs/deploy-monitor/deployment-best-practices" ] diff --git a/main/docs/deploy-monitor/auth0-cli.mdx b/main/docs/deploy-monitor/auth0-cli.mdx new file mode 100644 index 000000000..9759d6e85 --- /dev/null +++ b/main/docs/deploy-monitor/auth0-cli.mdx @@ -0,0 +1,187 @@ +--- +description: Learn about the Auth0 CLI and how to use it for tenant management. +'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png +'og:title': Auth0 CLI +'og:url': https://auth0.com/docs/ +permalink: auth0-cli +title: Auth0 CLI +'twitter:description': Learn about the Auth0 CLI and how to use it for tenant management. +'twitter:title': Auth0 CLI +--- + + +For complete CLI command reference and detailed usage information, see the [Auth0 CLI Reference Documentation](https://auth0.github.io/auth0-cli/). + + + + +Set up an [Auth0 Tenant](https://manage.auth0.com/). + + + +The Auth0 CLI is a command-line tool that provides direct access to the Auth0 Management API, enabling you to manage your Auth0 tenant from your terminal. It's designed for interactive use during development and can be integrated into scripts for automation. + +## Key Features + +* **Interactive Management**: Quickly create, update, and manage Auth0 resources from the command line +* **Authentication Support**: Multiple authentication methods including user login and machine-to-machine credentials +* **Resource Management**: Full CRUD operations for applications, APIs, connections, users, and more +* **Cross-Platform**: Available for macOS, Linux, and Windows +* **JSON Output**: Machine-readable output for scripting and automation + +## Installation + +### macOS + +Using Homebrew: + +```bash lines +brew tap auth0/auth0-cli +brew install auth0 +``` + +### Linux + +```bash lines +curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b /usr/local/bin +``` + +### Windows + +Using Scoop: + +```powershell lines +scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git +scoop install auth0 +``` + +Or download the latest release from the [GitHub releases page](https://github.com/auth0/auth0-cli/releases). + +## Authentication + +Before using the Auth0 CLI, you need to authenticate: + +```bash lines +auth0 login +``` + +This will open a browser window for you to log in to your Auth0 account. You can also authenticate using a machine-to-machine application: + +```bash lines +auth0 login --domain --client-id --client-secret +``` + +## Common Commands + +### Manage Applications + +```bash lines +# List all applications +auth0 apps list + +# Create a new application +auth0 apps create --name "My App" --type spa + +# Show application details +auth0 apps show + +# Update an application +auth0 apps update --callbacks "http://localhost:3000/callback" + +# Delete an application +auth0 apps delete +``` + +### Manage APIs + +```bash lines +# List all APIs +auth0 apis list + +# Create a new API +auth0 apis create --name "My API" --identifier "https://my-api.example.com" + +# Show API details +auth0 apis show +``` + +### Manage Users + +```bash lines +# List users +auth0 users list + +# Create a user +auth0 users create --email "user@example.com" --connection "Username-Password-Authentication" + +# Show user details +auth0 users show + +# Update a user +auth0 users update --email "newemail@example.com" +``` + +### Manage Tenant Settings + +```bash lines +# Show current tenant +auth0 tenants list + +# Update tenant settings +auth0 tenants update +``` + +## Using in Scripts + +The Auth0 CLI supports JSON output for easy parsing in scripts: + +```bash lines +# Get application details as JSON +auth0 apps show --json + +# Create an app and capture the output +auth0 apps create --name "My App" --type spa --json > app-details.json +``` + +## Use Cases + +The Auth0 CLI is ideal for: + +* **Development Workflows**: Quickly set up and configure Auth0 resources during development +* **Testing**: Create test applications and users for automated testing +* **Debugging**: Inspect and modify Auth0 configuration in real-time +* **Scripting**: Automate repetitive tasks with shell scripts +* **CI/CD Integration**: Integrate Auth0 configuration into your deployment pipelines + +## Comparison with Other Tools + +### Auth0 CLI vs Deploy CLI + +* **Auth0 CLI**: Interactive, command-by-command resource management. Best for development and ad-hoc tasks. +* **Deploy CLI**: Declarative, configuration-file-based tenant management. Best for managing entire tenant configurations across environments. + +### Auth0 CLI vs Terraform Provider + +* **Auth0 CLI**: Imperative commands for immediate changes. No state management. +* **Terraform Provider**: Declarative infrastructure-as-code with state tracking. Best for production infrastructure management. + +## Documentation and Support + +For complete documentation, command reference, and examples, visit: + +* [Auth0 CLI GitHub Repository](https://github.com/auth0/auth0-cli) +* [Auth0 CLI Documentation](https://auth0.github.io/auth0-cli/) + +## Next Steps + + + + Learn about managing tenant configuration with the Deploy CLI + + + Explore infrastructure-as-code with Terraform + + + Access the Auth0 Management API directly + + \ No newline at end of file diff --git a/main/docs/deploy-monitor/deploy-cli-tool.mdx b/main/docs/deploy-monitor/deploy-cli-tool.mdx index d1954e16e..89f54b22e 100644 --- a/main/docs/deploy-monitor/deploy-cli-tool.mdx +++ b/main/docs/deploy-monitor/deploy-cli-tool.mdx @@ -1,13 +1,13 @@ --- -description: Learn about the Auth0 Deploy CLI Tool and how it works. +description: Learn about the Auth0 Deploy CLI and how it works. 'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png 'og:title': Deploy CLI Tool 'og:url': https://auth0.com/docs/ permalink: deploy-cli-tool sidebarTitle: Overview -title: Deploy CLI Tool -'twitter:description': Learn about the Auth0 Deploy CLI Tool and how it works. -'twitter:title': Deploy CLI Tool +title: Auth0 Deploy CLI +'twitter:description': Learn about the Auth0 Deploy CLI and how it works. +'twitter:title': Auth0 Deploy CLI --- diff --git a/main/docs/fr-ca/deploy-monitor/auth0-cli.mdx b/main/docs/fr-ca/deploy-monitor/auth0-cli.mdx new file mode 100644 index 000000000..b9fc199b8 --- /dev/null +++ b/main/docs/fr-ca/deploy-monitor/auth0-cli.mdx @@ -0,0 +1,79 @@ +--- +description: Découvrez l'interface de ligne de commande Auth0 et comment l'utiliser pour la gestion des locataires. +'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png +'og:title': Auth0 CLI +'og:url': https://auth0.com/docs/ +permalink: auth0-cli +title: Auth0 CLI +'twitter:description': Découvrez l'interface de ligne de commande Auth0 et comment l'utiliser pour la gestion des locataires. +'twitter:title': Auth0 CLI +--- + + +Pour la référence complète des commandes CLI et des informations détaillées sur l'utilisation, consultez la [Documentation de référence Auth0 CLI](https://auth0.github.io/auth0-cli/). + + + + +Configurez un [locataire Auth0](https://manage.auth0.com/). + + + +L'interface de ligne de commande Auth0 (CLI) est un outil en ligne de commande qui fournit un accès direct à l'API de gestion Auth0, vous permettant de gérer votre locataire Auth0 depuis votre terminal. Il est conçu pour une utilisation interactive pendant le développement et peut être intégré dans des scripts pour l'automatisation. + +## Caractéristiques principales + +* **Gestion interactive**: Créez, mettez à jour et gérez rapidement les ressources Auth0 depuis la ligne de commande +* **Support d'authentification**: Plusieurs méthodes d'authentification, y compris la connexion utilisateur et les informations d'identification machine à machine +* **Gestion des ressources**: Opérations CRUD complètes pour les applications, les API, les connexions, les utilisateurs et plus encore +* **Multiplateforme**: Disponible pour macOS, Linux et Windows +* **Sortie JSON**: Sortie lisible par machine pour les scripts et l'automatisation + +## Installation + +### macOS + +En utilisant Homebrew: + +```bash lines +brew tap auth0/auth0-cli +brew install auth0 +``` + +### Linux + +```bash lines +curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b /usr/local/bin +``` + +### Windows + +En utilisant Scoop: + +```powershell lines +scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git +scoop install auth0 +``` + +Ou téléchargez la dernière version depuis la [page des versions GitHub](https://github.com/auth0/auth0-cli/releases). + +## Documentation et support + +Pour la documentation complète, la référence des commandes et des exemples, visitez: + +* [Dépôt GitHub Auth0 CLI](https://github.com/auth0/auth0-cli) +* [Documentation Auth0 CLI](https://auth0.github.io/auth0-cli/) + +## Prochaines étapes + + + + Découvrez la gestion de la configuration du locataire avec l'outil Deploy CLI + + + Explorez l'infrastructure en tant que code avec Terraform + + + Accédez directement à l'API de gestion Auth0 + + \ No newline at end of file From d8e5efcdc3fbf68b6d8f85ffbc7b68e7cf61b174 Mon Sep 17 00:00:00 2001 From: amanda-vanscoy Date: Mon, 5 Jan 2026 10:19:46 -0500 Subject: [PATCH 2/2] Doc review --- main/docs/deploy-monitor/auth0-cli.mdx | 73 +++++++++++++------------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/main/docs/deploy-monitor/auth0-cli.mdx b/main/docs/deploy-monitor/auth0-cli.mdx index 9759d6e85..24c639d23 100644 --- a/main/docs/deploy-monitor/auth0-cli.mdx +++ b/main/docs/deploy-monitor/auth0-cli.mdx @@ -1,39 +1,62 @@ --- -description: Learn about the Auth0 CLI and how to use it for tenant management. +description: Learn about Auth0 CLI and how to use it for tenant management. 'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png 'og:title': Auth0 CLI 'og:url': https://auth0.com/docs/ permalink: auth0-cli title: Auth0 CLI -'twitter:description': Learn about the Auth0 CLI and how to use it for tenant management. +'twitter:description': Learn about Auth0 CLI and how to use it for tenant management. 'twitter:title': Auth0 CLI --- - -For complete CLI command reference and detailed usage information, see the [Auth0 CLI Reference Documentation](https://auth0.github.io/auth0-cli/). - - Set up an [Auth0 Tenant](https://manage.auth0.com/). -The Auth0 CLI is a command-line tool that provides direct access to the Auth0 Management API, enabling you to manage your Auth0 tenant from your terminal. It's designed for interactive use during development and can be integrated into scripts for automation. +Auth0 CLI is a command-line tool that provides direct access to the Auth0 Management API, enabling you to manage your Auth0 tenant from your terminal. It's designed for interactive use during development and can be integrated into scripts for automation. + + +For complete CLI command reference and detailed usage information, read [Auth0 CLI Reference Documentation](https://auth0.github.io/auth0-cli/). + ## Key Features -* **Interactive Management**: Quickly create, update, and manage Auth0 resources from the command line +* **Interactive Management**: Create, update, and manage Auth0 resources from the command line * **Authentication Support**: Multiple authentication methods including user login and machine-to-machine credentials * **Resource Management**: Full CRUD operations for applications, APIs, connections, users, and more * **Cross-Platform**: Available for macOS, Linux, and Windows * **JSON Output**: Machine-readable output for scripting and automation -## Installation +## Use Cases + +Auth0 CLI is ideal for: + +* **Development Workflows**: Quickly set up and configure Auth0 resources during development +* **Testing**: Create test applications and users for automated testing +* **Debugging**: Inspect and modify Auth0 configuration in real-time +* **Scripting**: Automate repetitive tasks with shell scripts +* **CI/CD Integration**: Integrate Auth0 configuration into your deployment pipelines + +## Comparison with Other Tools + +### Auth0 CLI vs Deploy CLI + +* **Auth0 CLI**: Interactive, command-by-command resource management. Best for development and ad-hoc tasks. +* **[Deploy CLI](/docs/deploy-monitor/deploy-cli-tool)**: Declarative, configuration-file-based tenant management. Best for managing entire tenant configurations across environments. + +### Auth0 CLI vs Terraform Provider + +* **Auth0 CLI**: Imperative commands for immediate changes. No state management. +* **Terraform Provider**: Declarative infrastructure-as-code with state tracking. Best for production infrastructure management. + + +## Install Auth0 CLI ### macOS -Using Homebrew: +Configure with Homebrew: ```bash lines brew tap auth0/auth0-cli @@ -48,7 +71,7 @@ curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | s ### Windows -Using Scoop: +Configure with Scoop: ```powershell lines scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git @@ -57,15 +80,15 @@ scoop install auth0 Or download the latest release from the [GitHub releases page](https://github.com/auth0/auth0-cli/releases). -## Authentication +## Authenticate -Before using the Auth0 CLI, you need to authenticate: +To use the Auth0 CLI, you need to authenticate. When you run the following command, a browser window opens for you to log in to your Auth0 account: ```bash lines auth0 login ``` -This will open a browser window for you to log in to your Auth0 account. You can also authenticate using a machine-to-machine application: +To authenticate with a machine-to-machine application, use the following command: ```bash lines auth0 login --domain --client-id --client-secret @@ -143,28 +166,6 @@ auth0 apps show --json auth0 apps create --name "My App" --type spa --json > app-details.json ``` -## Use Cases - -The Auth0 CLI is ideal for: - -* **Development Workflows**: Quickly set up and configure Auth0 resources during development -* **Testing**: Create test applications and users for automated testing -* **Debugging**: Inspect and modify Auth0 configuration in real-time -* **Scripting**: Automate repetitive tasks with shell scripts -* **CI/CD Integration**: Integrate Auth0 configuration into your deployment pipelines - -## Comparison with Other Tools - -### Auth0 CLI vs Deploy CLI - -* **Auth0 CLI**: Interactive, command-by-command resource management. Best for development and ad-hoc tasks. -* **Deploy CLI**: Declarative, configuration-file-based tenant management. Best for managing entire tenant configurations across environments. - -### Auth0 CLI vs Terraform Provider - -* **Auth0 CLI**: Imperative commands for immediate changes. No state management. -* **Terraform Provider**: Declarative infrastructure-as-code with state tracking. Best for production infrastructure management. - ## Documentation and Support For complete documentation, command reference, and examples, visit: