Deploy CLI Tool

Entities created via the Management API may share user data with or receive user data from third parties. For details, please see the individual endpoints.

Auth0 supports continuous integration and deployment (CI/CD) of Auth0 tenants and integration into existing CI/CD pipelines using the Deploy CLI tool.

The Deploy CLI tool (auth0-deploy-cli) supports two methods to import and export the following Auth0 tenant configuration objects:

  • Actions

  • Clients (Applications)

  • Client Grants

  • Connections

  • Grants

  • Hooks

  • Hook Secrets

  • Organizations

  • Resource Servers (APIs)

  • Roles

  • Rules

  • Rules Configs

  • Email Templates and providers

  • Guardian

  • Tenants settings (including Pages and Migrations)

You can export the data to a predefined directory structure or a YAML configuration file. You can call the tool programmatically. You can also use the tool to replace environment variables.

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 it in production.

Upgrade to version 7

For version 7, the auth0-deploy-cli tool adds support for Organizations and Actions, and drops support for Node.js version 8.

Upgrading to Deploy CLI Tool v7

Upgrading to Deploy CLI Tool v7 from v5 requires that the auth0-deploy-cli application be granted the following additional permissions (scopes) for the Auth0 Management API:

  • create:actions

  • read:actions

  • update:actions

  • delete:actions

  • read:organizations

  • update:organizations

  • create:organizations

  • delete:organizations

  • create:organization_connections

  • read:organization_connections

  • update:organization_connections

  • delete:organization_connections

To learn how to modify the required scopes, read Create and Configure the Deploy CLI Application.

Previous versions

Features released in previous versions of the Deploy CLI Tool are listed below. For a complete list of changes, see the GitHub changelog.

Deploy CLI Tool v4

For version 4, the auth0-deploy-cli tool was updated to add support for Hooks and Hook Secrets.

Upgrading to Deploy CLI Tool v4

Upgrading to Deploy CLI Tool v4 requires that the auth0-deploy-cli application be granted the following additional permissions (scopes) for the Auth0 Management API:

  • create:hooks

  • read:hooks

  • update:hooks

  • delete:hooks

To learn how to modify the required scopes, read Create and Configure the Deploy CLI Application.

Deploy CLI Tool v3

For version 3, the auth0-deploy-cli tool was updated to include the following changes.

  • Added options to the config:

    • INCLUDED_PROPS: Enables export of properties that are excluded by default (e.g., client_secret)

    • EXCLUDED_PROPS: Provides ability to exclude any unwanted properties from exported objects

  • Removed --strip option from export command. IDs will now be stripped by default; to override, use --export_ids or AUTH0_EXPORT_IDENTIFIERS: true.

Deploy CLI Tool v2

For version 2, the auth0-deploy-cli tool was updated to include the following changes.

  • Added YAML support

  • Added support for export (deprecation of separate auth0 dump tool)

  • Delete support - The tool will, if configured via AUTH0_ALLOW_DELETE, delete objects if does not exist within the deploy configuration.

  • Support for additional Auth0 objects

    • Connections including Social, Enterprise and Passwordless configurations.

    • Improved support for database connections and associated configuration.

    • Email Templates

    • Email Provider

    • Client Grants

    • Rule Configs (Import Only)

    • Guardian config

    • Better support for pages

    • Tenant level settings

  • Added support to be called programmatically

  • Improved logging

  • To simplify the tool the slack hook was removed. You can invoke the tool programmatically to support calling your own hooks

  • Support referencing clients by their name vs client_id (automatic mapping during export/import)

  • Simplified to support future Auth0 object types

Learn more