Skip to content

mgmt: ManagementApi v8#964

Merged
kailash-b merged 38 commits into
masterfrom
v8
Apr 2, 2026
Merged

mgmt: ManagementApi v8#964
kailash-b merged 38 commits into
masterfrom
v8

Conversation

@kailash-b
Copy link
Copy Markdown
Contributor

@kailash-b kailash-b commented Apr 1, 2026

This PR includes all the changes related to the new v8 version.


✨ What's Included

v8 is a major release that includes a completely redesigned, OpenAPI-generated SDK:

  • 🔄 OpenAPI-Generated SDK: The Management API SDK is now generated from Auth0's OpenAPI specifications using Fern, ensuring the SDK stays up-to-date and consistent with the API.
  • 🔑 Automatic Token Management: The new ManagementClient wrapper handles token acquisition and refresh automatically — no more manual token management.
  • 🛡️ Improved Type Safety: All API operations use strongly typed request and response models for better compile-time safety.
  • 📂 Better Organization: API operations are organized into logical hierarchical sub-clients for improved discoverability.
  • Enhanced Exception Handling: A unified exception hierarchy with specific exception types for different HTTP status codes.
  • 📡 Raw HTTP Response Access: Access the raw HTTP response via the .WithRawResponse() method.
  • 🏷️ Optional<T> Type: Distinguish between undefined and explicitly null values in PATCH operations.
  • 📄 Async Pagination: Built-in support for pagination with async enumeration.
  • 🧩 Comprehensive Interfaces: Full interfaces for all clients to simplify dependency injection and testing.

🔄 What Changed Since Beta

Since the beta announcement, we've made the following improvements based on feedback and continued development:

  • 🔌 Custom Token Provider Support: Refactored token management to support pluggable token providers via DelegateTokenProvider, giving you full control over how tokens are acquired alongside the built-in ClientCredentialsTokenProvider.
  • 🏗️ Simplified ManagementClient Internals: ManagementClient now inherits from the generated ManagementApiClient, removing redundant initialization and reducing wrapper complexity.
  • 📋 Auth0-Client Telemetry Header: Added the Auth0-Client header via a ClientOptions.Internal partial class, ensuring proper SDK telemetry is sent with every request.
  • 🧹 Dropped .NET 8 Compile-Time Requirement: Removed .NET 8 as a build-time dependency, simplifying the build toolchain while maintaining full runtime support.
  • 🔃 Continuous API Sync: Multiple Fern-based regenerations to keep the SDK aligned with the latest Auth0 Management API changes.

📦 Installation

Install or upgrade via NuGet:

dotnet add package Auth0.ManagementApi --version 8.0.0

Or update your .csproj:

<PackageReference Include="Auth0.ManagementApi" Version="8.0.0" />

Supported Platforms

  • .NET 8.0+
  • .NET Framework 4.6.2+
  • .NET Standard 2.0+

💥 Breaking Changes

This release contains breaking changes to client initialization, request/response types, method signatures, and exception handling. All existing v7 Management API code will require updates to work with v8.

The Authentication API (Auth0.AuthenticationApi) remains unchanged — your existing authentication code will continue to work as-is.


📖 Migration Guide

We have a comprehensive migration guide with side-by-side examples and detailed mappings from v7 to v8:

👉 V8_MIGRATION_GUIDE.md


⚠️ v7 Maintenance Policy

With v8 now GA, v7 will continue to receive security fixes only for a limited time. We strongly encourage all users to migrate to v8 at your earliest convenience. No new features will be added to v7.


🙏 Thank You

Thank you to everyone who tested the beta releases and provided feedback — your input was invaluable in shaping this release.

As always, we welcome your feedback. Please feel free to open an issue if you have any questions or suggestions.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 1, 2026

Codecov Report

❌ Patch coverage is 61.15272% with 2386 lines in your changes missing coverage. Please review.
✅ Project coverage is 34.68%. Comparing base (f979eff) to head (433d761).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...th0.ManagementApi/Actions/Modules/ModulesClient.cs 62.08% 194 Missing and 24 partials ⚠️
src/Auth0.ManagementApi/Actions/ActionsClient.cs 61.69% 185 Missing and 23 partials ⚠️
...entApi/Branding/Phone/Templates/TemplatesClient.cs 59.09% 186 Missing and 21 partials ⚠️
...entApi/Branding/Phone/Providers/ProvidersClient.cs 58.89% 160 Missing and 18 partials ⚠️
src/Auth0.ManagementApi/Clients/ClientsClient.cs 60.71% 156 Missing and 20 partials ⚠️
...0.ManagementApi/ClientGrants/ClientGrantsClient.cs 62.62% 129 Missing and 16 partials ⚠️
...uth0.ManagementApi/Branding/Themes/ThemesClient.cs 58.55% 129 Missing and 14 partials ⚠️
...gementApi/Clients/Credentials/CredentialsClient.cs 59.60% 129 Missing and 14 partials ⚠️
...mentApi/Actions/Modules/Versions/VersionsClient.cs 63.05% 88 Missing and 11 partials ⚠️
...0.ManagementApi/Actions/Versions/VersionsClient.cs 64.79% 83 Missing and 11 partials ⚠️
... and 50 more
Additional details and impacted files
@@             Coverage Diff             @@
##           master     #964       +/-   ##
===========================================
- Coverage   80.21%   34.68%   -45.54%     
===========================================
  Files         464     2341     +1877     
  Lines        6045    92795    +86750     
  Branches      293     5383     +5090     
===========================================
+ Hits         4849    32182    +27333     
- Misses       1104    58920    +57816     
- Partials       92     1693     +1601     
Flag Coverage Δ
authIntTests 3.26% <1.98%> (-27.42%) ⬇️
mgmtIntTests 33.30% <61.15%> (-26.92%) ⬇️
unittests 0.36% <0.00%> (-17.91%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kailash-b kailash-b changed the title V8 mgmt: ManagementApi v8 Apr 2, 2026
@kailash-b kailash-b marked this pull request as ready for review April 2, 2026 05:30
@kailash-b kailash-b requested a review from a team as a code owner April 2, 2026 05:30
@kailash-b kailash-b enabled auto-merge (squash) April 2, 2026 05:31
@kailash-b kailash-b disabled auto-merge April 2, 2026 05:31
Copy link
Copy Markdown

@tanya732 tanya732 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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.

3 participants