Import/Export Tenant Configuration to Directory Structure
auth0-deploy-cli tool includes a directory option that allows you to export and import an existing Auth0 tenant configuration into a predefined directory structure.
Import tenant configuration
config.json.example, making sure to replace the placeholder values with the values specific to your configuration.
client ID and secret from your newly-created client (the client is named
auth0-deploy-cli-extension if you used the extension).
By default, the tool merges with your current environment variables and overrides the
config.json file (which has the same top key). You can use the
--no-env option to disable the override via the command line.
You can either set the environment variables, or you can place the values in a configuration file anywhere on the file system that is accessible by the CLI tool.
- Deploy using the following command:
Example: configuration file
Here is an example of a
Caching user profiles
Export tenant configuration
To export your current tenant configuration, run a command that's similar to:
a0deploy export -c config.json -f directory -o path/to/export
When importing objects into Auth0 tenants, Auth0 generates new IDs. To avoid import failure, identifier fields are stripped from the Auth0 objects on export by default. To override this behavior, use:
--export_ids or AUTH0_EXPORT_IDENTIFIERS: true
Some of the settings cannot be exported, such as
rulesConfigs values. After exporting, you may need to update the values in
tenant.yaml if you see schema-related errors during the import process.
For more information, see Environment Variables and Keyword Mappings.
Custom user profile data
Directory structure example
Here is a sample of what the export directory structure looks like (for full details on everything that can be included, please refer to the extension's repository: