Skip to content

5.0.0

Choose a tag to compare

@github-actions github-actions released this 04 Feb 08:49
ae22a65

What's New in v5.0.0

⚠️ BREAKING CHANGES - Major Rewrite

This is a complete rewrite of the Auth0 Python SDK with significant breaking changes from v4.x. Users will need to update their code when migrating from v4.x to v5.0.0.

Added Features

  • New Fern-generated SDK: Complete Management API rewrite generated from Auth0's OpenAPI specifications
  • Hierarchical package structure: Organized Management APIs into logical sub-clients for better discoverability
  • Strongly typed interfaces: Pydantic models provide specific request/response types replacing generic dictionaries
  • Automatic token management: Built-in client credentials handling with automatic token refresh
  • Enhanced pagination: New SyncPager and AsyncPager classes for easy iteration over paginated results
  • First-class async support: Full async/await support with AsyncManagementClient
  • Better IDE support: Improved code completion, type hints, and inline documentation

Key Breaking Changes

  • Import paths changed from from auth0.management import Auth0 to from auth0.management import ManagementClient
  • Client initialization changed from Auth0(domain, management_token) to ManagementClient(domain, client_id, client_secret) with automatic token management
  • Response types changed from dictionaries to Pydantic models (use .model_dump() to convert back to dict)
  • Method organization changed from flat (client.users.list()) to hierarchical where applicable
  • Pagination parameters changed - some endpoints use per_page, others use take
  • Python version requirement increased from ≥3.7 to ≥3.8
  • Error handling changed from Auth0Error to ApiError base class

Important Notes

  • ✅ The authentication package is NOT affected by these changes. Authentication APIs remain the same between v4 and v5.
  • 📚 Complete migration guide available at v5_MIGRATION_GUIDE.md
  • 🎯 This is the stable GA release following v5.0.0-beta.0
  • 🔧 Auth0 telemetry headers implemented with dynamic versioning (no manual updates needed)
  • 📖 Full API reference available at reference.md