Skip to content

Latest commit

 

History

History
164 lines (106 loc) · 8.11 KB

README.md

File metadata and controls

164 lines (106 loc) · 8.11 KB
Raw

Deploy CLI Banner

npm version CircleCI codecov License: MIT

Help Us Improve Auth0 Deploy CLI – Take Our Survey!

👋 Hello developers! We're on a mission to make Auth0 Deploy CLI the best it can be, and we need YOUR help. We've put together a brief survey to understand how you use Deploy CLI, what you love about it, and where you think we can do better.

Why Should You Take the Survey?

  • Direct Impact: Your feedback will directly influence the future of Deploy CLI. Ever wished for a feature or fix? Here's your chance to let us know.
  • It's Quick: The survey takes less than 10 minutes to complete.

Privacy

We care about your privacy. All data collected is anonymous and will only be used for improving Auth0 Deploy CLI.

Ready to Make a Difference?

Click here to take the survey

Thank you for helping us make Auth0 Deploy CLI better for everyone!

The Auth0 Deploy CLI is a tool that helps you manage your Auth0 tenant configuration. It integrates into your development workflows as a standalone CLI or as a node module.

Supported resource types: 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.

🎢 Highlights • 📚 Documentation • 🚀 Getting Started • 💬 Feedback

Highlights

  • Multi-Environment Oriented: Designed to help you test your applications' Auth0 integrations from feature branch all the way to production.
  • Keyword Replacement: Shared resource configurations across all environments with dynamic keyword replacement.
  • Versatile: Integrate into your CI/CD workflows either as a CLI or as a Node module.

Documentation

Getting Started

This guide will help you to a working implementation of the Deploy CLI tool used as a standalone CLI. There are three main steps before the Deploy CLI can be run:

  1. Create a Dedicated Auth0 Application
  2. Configure the Deploy CLI
  3. Calling the Deploy CLI

Warning This tool can be destructive to your Auth0 tenant. It is recommended to be familiar with the AUTH0_ALLOW_DELETE configuration and to test on development tenants prior to using in production.

Prerequisites

Install the Deploy CLI

To run as a standalone command-line tool:

npm install -g auth0-deploy-cli

Create a dedicated Auth0 Application

In order for the Deploy CLI to call the Management API, a dedicated Auth0 application must be created to make calls on behalf of the tool.

  1. From the Auth0 dashboard, navigate to Applications > Applications
  2. Click “Create Application”
  3. On Create application page: a. Name it “Deploy CLI” or similar b. Select “Machine to Machine Applications” as application type c. Click “Create”
  4. On the “Authorize Machine to Machine Application” page a. Select “Auth0 Management API” b. Select the appropriate permissions for the resources you wish to manage. Refer to the Client Scopes section for more information. c. Click “Authorize”

Warning The Deploy CLI's own client is unconfigurable by itself to prevent potentially destructive changes.

Client Scopes

The designated application needs to be granted scopes in order to allow the Deploy CLI to execute Management operations.

The principle of least privilege is abided, so it will operate within the set of permissions granted. At a minimum, read:clients need to be selected, but is is recommended to select read:, create: and update: permissions for all resource types within management purview. To enable deletions, the delete: scopes are also necessary.

Configure the Deploy CLI

The Deploy CLI can be configured two ways, through a config.json file and through environment variables. The decision to choose one or both would depend on your specific use case and preferences. More comprehensive information about configuring the tool can be found on the Configuring the Deploy CLI page. However, for this example, the simplest way to get going is by setting the following environment variables:

  • AUTH0_DOMAIN
  • AUTH0_CLIENT_ID
  • AUTH0_CLIENT_SECRET

These values can be found in the “Settings” and “Credentials“ tabs within the Auth0 application created in the previous step.

Calling the Deploy CLI

Finally, with above complete, the Deploy CLI export command can be run:

a0deploy export --format=yaml --output_folder=local

Once the process completes, observe the resource configuration files generated in the local directory. Then, run the import command, which pushes configuration from the local machine to your Auth0 tenant:

a0deploy import --config_file=config.json --input_file local/tenant.yaml

Refer to Using as a CLI documentation for a comprehensive list of flags and options.

Feedback

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Vulnerability Reporting

Please do not report security vulnerabilities on the public Github issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Auth0 Logo

Auth0 is an easy to implement, adaptable authentication and authorization platform.
To learn more checkout Why Auth0?

This project is licensed under the MIT license. See the LICENSE file for more info.