Excluding Properties From an Auth0 deploy-cli Export

Overview

This article provides instructions on how to exclude specific configuration properties when using the deploy-cli Export. This process is useful for preventing potential validation errors when applying a configuration from one tenant to another that may have different features enabled.

Applies To
  • Auth0 Deploy CLI
  • Configuration Exports
Solution

The Auth0 Deploy CLI can be configured to omit specific properties from an export by modifying the config.json file.

  1. Locate and open the config.json file used by the Deploy CLI.

  2. Add or modify the EXCLUDED_PROPS key in the file. This key accepts an object where each key is a resource type (e.g., clientGrantsclients) and its value is an array of property names to exclude.

  3. To exclude a property, add the resource name as a key and an array containing the property name string. For example, to prevent the subject_type property from being exported for all clientGrants, add the following configuration:

    
    
    "EXCLUDED_PROPS": {
      "clientGrants": ["subject_type"]
    }
    
    

  4. Save the config.json file.

  5. Run the npx a0deploy export command. The resulting YAML file will not contain the properties specified in the EXCLUDED_PROPS setting.

Recommended content

No recommended content found...