Skip to content

Conversation

@patkub
Copy link
Contributor

@patkub patkub commented Nov 8, 2024

🔧 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

  1. 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.

📷 Screenshots

  • Log Streams need to be excluded:
    Screenshot_20241108_125810
  • Custom domains are optional, if you don't want to add credit card info:
    Screenshot_20241108_125937

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

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

@patkub patkub requested a review from a team as a code owner November 8, 2024 17:47
logStreams are mandatory, and customDomains are optional.

Ref Issue auth0#969
@patkub patkub force-pushed the feature/free-tier-docs branch from 8826a27 to 94dc159 Compare November 8, 2024 19:06
@kushalshit27 kushalshit27 merged commit 6d2f9bc into auth0:master Nov 11, 2024
@patkub patkub deleted the feature/free-tier-docs branch November 11, 2024 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants