auth0-deploy-cli
Advanced tools
Auth0 supports continuous integration and deployment (CI/CD) of Auth0 Tenants through our source control extensions and integration into existing CI/CD pipelines by using this auth0-deploy-cli tool.
The auth0-deploy-cli tool supports the importing and exporting of Auth0 Tenant configuration data.
Supported Features
This tool can be destructive to your Auth0 tenant. Please ensure you have read the documentation and tested the tool on a development tenant before using in production.
The auth0-deploy-cli tool was refactored bringing the following updates.
AUTH0_ALLOW_DELETE, delete objects if does not exist within the deploy configuration.The auth0-deploy-cli was completely rewritten from version 1 to version 2 which means it is not backwards compatible. Please consider the following when upgrading:
npm i -g auth0-deploy-cli
For this tool to function it must be authorized to the Auth0 Management API. You can do this by creating an application in your Auth0 service that has access to the management API with the following scopes before.
Use the Auth0 Deploy CLI Extension to create the application. At the bottom of the README are instructions for doing this by hand instead.
This tool supports multiple methods to import and export Auth0 configuration objects.
Please refer to Directory README for usage instructions and examples.
Please refer to YAML README for usage instructions and examples.
The tool can be called programmatically. Please see below for an example.
import { deploy, dump } from 'auth0-deploy-cli';
const config = {
AUTH0_DOMAIN: process.env.AUTH0_DOMAIN,
AUTH0_CLIENT_SECRET: process.env.AUTH0_CLIENT_SECRET,
AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID,
AUTH0_EXPORT_IDENTIFIERS: false,
AUTH0_ALLOW_DELETE: false
};
// Export Tenant Config
dump({
output_folder: 'path/to/directory', // Output directory
base_path: basePath, // Allow to override basepath, if not take from input_file
config_file: configFile, // Option to a config json
config: configObj, // Option to sent in json as object
export_ids: exportIds, // Export the identifier field for each object type
secret // Optionally pass in auth0 client secret seperate from config
})
.then(() => console.log('yey export was successful'))
.catch(err => console.log(`Oh no, something went wrong. Error: ${err}`));
// Import tenant config
deploy({
input_file: 'path/to/yaml/or/directory', // Input file for directory, change to .yaml for YAML
base_path: basePath, // Allow to override basepath, if not take from input_file
config_file: configFile, // Option to a config json
config: configObj, // Option to sent in json as object
env, // Allow env variable mappings from process.env
secret // Optionally pass in auth0 client secret seperate from config
})
.then(() => console.log('yey deploy was successful'))
.catch(err => console.log(`Oh no, something went wrong. Error: ${err}`));
The auth0-deploy-cli tool leverages the Auth0 Management API passing through objects for creates, updates and deletions.
You may experience Bad Request and Payload validation errors. These errors are returned from the Auth0 Management API, and usually mean the object has attributes which are not writable or no longer available (legacy). This can happen when exporting from an older Auth0 tenant and importing into a newly created tenant. In this scenario you may need to update your configuration to support the new object format. See #45 for a potential fix.
The following options are supported by the cli.
a0deploy --help
Auth0 Deploy CLI
Commands:
a0deploy import Deploy Configuration
a0deploy export Export Auth0 Tenant Configuration
Options:
--help Show help [boolean]
--version Show version number [boolean]
--verbose, -v Dump extra debug information. [string] [default: false]
--proxy_url, -p A url for proxying requests, only set this if you are behind a proxy. [string]
Examples:
a0deploy export -c config.json -f yaml -o path/to/export Dump Auth0 config to folder in YAML format
a0deploy export -c config.json -f directory -o path/to/export Dump Auth0 config to folder in directory format
a0deploy import -c config.json -i tenant.yaml Deploy Auth0 via YAML
a0deploy import -c config.json -i path/to/files Deploy Auth0 via Path
See README (https://github.com/auth0/auth0-deploy-cli) for more in-depth information on configuration and setup.
The recommended approach for utilizing this CLI is to incorporate it into your build system. Create a repository to store your deploy configuration, then create a set of configuration files for each environment. On your continuous integration server, have a deploy build for each environment. This deploy build should update a local copy of the deploy configuration repository, then run the CLI to deploy it to that environment. Read on for more detailed information.
The recommended approach is to have a different Auth0 tenant/account for each environment. For example: fabrikam-dev, fabrikam-uat, fabrikam-staging, and fabrikam-prod.
Your configuration repository should contain the files as described in the selected option (Directory or YAML)
You should have a branch for each tenant/account. This allows you to make changes to dev, but not deploy them until you merge. With this setup, you can have each environment have a CI task that automatically deploys the changes to its target environment when the branch is updated with the latest.
So your flow would be as follows: dev changes are tested, then merged to uat, once tested they are merged to staging, once staging is tested they are merged to prod.
You may want to set your prod to only deploy when triggered manually.
Your CI server should have a different deploy task and config for each environment. Since each tenant/account will need to have the auth0-deploy-cli-extension installed in it with a different domain, client ID, and secret, this has to happen anyway and will avoid accidentally deploying to the wrong environment.
The deploy task should follow these steps:
You should not have to store differences between environments in the Deploy Configuration Repository. Use the keyword mappings to allow the repository to be environment agnostic, and instead store the differences in the separate config.json files for each environment that are stored on the CI server.
Clone the GitHub repo and install globally
git clone git@github.com:auth0/auth0-deploy-cli
cd auth0-deploy-cli
npm install
npm run test
See https://github.com/auth0/auth0-deploy-cli/issues
MIT
FAQs
A command line tool for deploying updates to your Auth0 tenant
We found that auth0-deploy-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 41 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.