Excluding Properties From an Auth0 deploy-cli Export
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.
- Auth0 Deploy CLI
- Configuration Exports
The Auth0 Deploy CLI can be configured to omit specific properties from an export by modifying the config.json file.
-
Locate and open the
config.jsonfile used by the Deploy CLI. -
Add or modify the
EXCLUDED_PROPSkey in the file. This key accepts an object where each key is a resource type (e.g.,clientGrants,clients) and its value is an array of property names to exclude. -
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_typeproperty from being exported for allclientGrants, add the following configuration:"EXCLUDED_PROPS": { "clientGrants": ["subject_type"] } -
Save the
config.jsonfile. -
Run the npx a0deploy export command. The resulting YAML file will not contain the properties specified in the
EXCLUDED_PROPSsetting.