search

auth0 / auth0-deploy-cli

The Auth0 Deploy CLI is a tool that helps you manage your Auth0 tenant configuration. It integrates into your development workflows as a standalone CLI or as a node module.
MIT License
248 stars 155 forks source link

Document resources that need to be excluded on free tier tenants #978

Closed patkub closed 2 weeks ago

patkub commented 2 weeks ago

🔧 Changes

Documented how to use Auth0 Deploy CLI with free tier tenants, after recent pricing changes. Paid features need to be excluded from management.

📚 References

🔬 Testing

  1. Use a free tier Auth0 tenant, without credit card information.

  2. Try exporting the tenant with a basic config such as:

    {
"AUTH0_DOMAIN": "<YOUR_TENANT_DOMAIN_HERE>",
"AUTH0_CLIENT_ID": "<MACHINE_TO_MACHINE_CLIENT_ID_HERE>",
"AUTH0_CLIENT_SECRET": "<MACHINE_TO_MACHINE_CLIENT_SECRET_HERE>",
}

    You will encounter an error, due to trying to export a paid feature. Error: Problem loading tenant data from Auth0 Forbidden: There must be a verified credit card on file to perform this operation

  3. When exporting from a free tier tenant, you need to exclude paid features using a config such as:

    {
"AUTH0_DOMAIN": "<YOUR_TENANT_DOMAIN_HERE>",
"AUTH0_CLIENT_ID": "<MACHINE_TO_MACHINE_CLIENT_ID_HERE>",
"AUTH0_CLIENT_SECRET": "<MACHINE_TO_MACHINE_CLIENT_SECRET_HERE>",
"AUTH0_EXCLUDED": ["logStreams", "customDomains"]
}

    You should no longer encounter errors importing/exporting paid features from free tier tenants.

:camera: Screenshots

Unit Tests

I believe the CircleCI E2E tests are failing because I don't have permissions to the test environment. These environment variables are most likely invalid/null on my forked branch.

Using environment variables from project settings and/or contexts:
  AUTH0_E2E_CLIENT_ID=**REDACTED**
  AUTH0_E2E_CLIENT_SECRET=**REDACTED**
  AUTH0_E2E_TENANT_DOMAIN=**REDACTED**

📝 Checklist