What's New in Deploy CLI Tool

Features released in each version 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 include the following changes.

  • Added 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