Reset an Auth0 Tenant to Default Settings
Last Updated:
Overview
Auth0 does not provide a native method to reset a tenant configuration to default settings. However, administrators can reset the configuration to a near-default state using the Auth0 Deploy Command Line Interface (CLI). This guide provides the steps to generate a source template from a default tenant and apply it to the destination tenant to overwrite existing configurations.
Applies To
- Auth0
- Auth0 Deploy CLI
- Tenant Configuration
Solution
There is no out-of-the-box way to reset a tenant's configuration. However, it is possible to reset the configuration to a near default state using the Auth0 Deploy CLI with instructions outlined below
Preparation
Install the tool a0deploy by running the following in the command-line interface:
npm i -g auth0-deploy-cli
Generate the source template from the tenant
- Either create a new tenant or use an existing tenant as the source for the configuration.
- In a new directory, create the following files:
- config.json from the example config here.
- Enable Deletions: In the
config.jsonfile (or via environment variables), set the deletion flag to true:"AUTH0_ALLOW_DELETE": true - Complete the rest of the
config.jsonfile details from the source tenant.
-
Get a snapshot of the tenant using the following command.
a0deploy export --config_file config.json --format yaml --output_folder ./
Update the destination tenant
-
Update the configuration file (
config.json) used for the import to point to the destination tenant. - Update the tenant with its stored state:
a0deploy import --config_file config.json --format yaml --input_file ./tenant.yaml
NOTE: Certain tenant-level settings, such as billing plans, custom domains, and early access features, must be checked and managed via the Auth0 Dashboard and are outside the scope of the Auth0 Deploy CLI.