Skip to content

mgmt: Adds v8 for ManagementApi#911

Closed
kailash-b wants to merge 1 commit into
masterfrom
mgmt/v8
Closed

mgmt: Adds v8 for ManagementApi#911
kailash-b wants to merge 1 commit into
masterfrom
mgmt/v8

Conversation

@kailash-b
Copy link
Copy Markdown
Contributor

Changes

This PR introduces v8 of the Management API SDK, a major version update that represents a complete modernization of the SDK architecture and developer experience.

What's New:

  • OpenAPI-Generated SDK: The Management API SDK is now generated from Auth0's OpenAPI specifications using Fern, ensuring consistency, accuracy, and easier maintenance going forward.

  • Automatic Token Management: Introduced a new ManagementClient wrapper that handles token acquisition and refresh automatically using client credentials, eliminating the need for manual token management.

  • Improved Type Safety: All API operations now use strongly typed request and response models with proper validation and clear naming conventions (*RequestContent, *ResponseContent, *RequestParameters).

  • Better Organization: API operations are now organized into logical hierarchical sub-clients (e.g., client.Users.Permissions, client.Users.Roles, client.Organizations.Members) for better discoverability and cleaner code.

  • Enhanced Exception Handling: Unified exception hierarchy based on ManagementApiException with specific exception types for different HTTP status codes (NotFoundError, BadRequestError, TooManyRequestsError, etc.).

  • New Features:

    • Raw response access via .WithRawResponse() for accessing status codes, headers, and other HTTP metadata
    • Optional<T> type for distinguishing between undefined and explicitly null values in PATCH operations
    • Built-in pagination support with async enumeration
    • Comprehensive interfaces for dependency injection and testing
  • Migration Support: Comprehensive migration guide (V8_MIGRATION_GUIDE.md) with side-by-side examples and detailed mappings from v7 to v8.

Breaking Changes:

This is a major version with 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 and fully compatible.

References

Please include relevant links supporting this change such as a:

  • support ticket
  • community post
  • StackOverflow post
  • support forum thread

Testing

Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

  • This change adds unit test coverage

  • This change adds integration test coverage

  • This change has been tested on the latest version of the platform/language or why not

Checklist

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 4, 2026

Codecov Report

❌ Patch coverage is 2.16509% with 5061 lines in your changes missing coverage. Please review.
✅ Project coverage is 4.52%. Comparing base (e024a15) to head (7706f3b).

Files with missing lines Patch % Lines
src/Auth0.ManagementApi/Actions/ActionsClient.cs 1.34% 515 Missing ⚠️
...entApi/Branding/Phone/Templates/TemplatesClient.cs 0.82% 483 Missing ⚠️
src/Auth0.ManagementApi/Clients/ClientsClient.cs 0.93% 424 Missing ⚠️
...entApi/Branding/Phone/Providers/ProvidersClient.cs 0.95% 413 Missing ⚠️
...gementApi/Clients/Credentials/CredentialsClient.cs 1.17% 337 Missing ⚠️
...uth0.ManagementApi/Branding/Themes/ThemesClient.cs 1.20% 328 Missing ⚠️
...0.ManagementApi/ClientGrants/ClientGrantsClient.cs 1.64% 299 Missing ⚠️
...0.ManagementApi/Actions/Versions/VersionsClient.cs 1.55% 254 Missing ⚠️
...entApi/Actions/Triggers/Bindings/BindingsClient.cs 2.17% 180 Missing ⚠️
...anagementApi/Branding/Templates/TemplatesClient.cs 2.51% 155 Missing ⚠️
... and 51 more

❗ There is a different number of reports uploaded between BASE (e024a15) and HEAD (7706f3b). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (e024a15) HEAD (7706f3b)
mgmtIntTests 1 0
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #911       +/-   ##
==========================================
- Coverage   79.18%   4.52%   -74.66%     
==========================================
  Files         458    1779     +1321     
  Lines        5932   68079    +62147     
  Branches      278    4078     +3800     
==========================================
- Hits         4697    3080     -1617     
- Misses       1140   64884    +63744     
- Partials       95     115       +20     
Flag Coverage Δ
authIntTests 4.27% <2.16%> (-26.25%) ⬇️
mgmtIntTests ?
unittests 0.47% <0.00%> (-8.46%) ⬇️

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.

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.

1 participant