Skip to content

Commit 3e9a05a

Browse files
committed
Updated changelog
1 parent b3a895b commit 3e9a05a

File tree

1 file changed

+60
-2
lines changed

1 file changed

+60
-2
lines changed

CHANGELOG.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,66 @@
33
## [3.0.0](https://github.com/auth0/auth0-java/tree/3.0.0) (2026-01-09)
44
[Full Changelog](https://github.com/auth0/auth0-java/compare/2.27.0...3.0.0)
55

6-
**Added**
7-
- Adding v3 changes [\#790](https://github.com/auth0/auth0-java/pull/790) ([tanya732](https://github.com/tanya732))
6+
7+
### Added Features
8+
9+
- **New OpenAPI-generated Management API SDK**: Complete rewrite of the Management API client using Fern code generation.
10+
- **Improved type safety**: using enums
11+
- **Automatic pagination:** `SyncPagingIterable<T>` for automatic pagination
12+
- **Nullability annotations** on generated POJOs
13+
- **error handling**: unified `ManagementApiException` class
14+
- Support for **explicit null values** in **PATCH** operations
15+
- **HTTP client** upgraded to **OkHttp 5.2.1**
16+
17+
### ⚠️ Breaking Changes — Major Rewrite
18+
- The Management API client has been fully rewritten using Fern OpenAPI code generation. Applications migrating from v2.x must update their code.
19+
- **Key Breaking Changes**:
20+
- Hierarchical sub-clients replace flat entity APIs.
21+
- Manual pagination removed in favor of `SyncPagingIterable<T>`.
22+
- Unified exception handling via `ManagementApiException`.
23+
- Client initialization updated to `ManagementApi.builder()`.
24+
- Request and response models now use generated, immutable `*RequestContent`, `*ResponseContent`, and `*RequestParameters` types.
25+
- Package structure updated across all Management API resources.
26+
27+
### Deprecated APIs have been removed:
28+
- Removed deprecated AuthAPI constructors.
29+
- Removed legacy authentication and signup helpers.
30+
- Deprecated networking helpers removed:
31+
- Removed deprecated method from MultipartRequest.
32+
- Removed internal EmptyBodyVoidRequest
33+
- Removed HttpOptions
34+
- Removed EXAMPLES.md, refer [reference.md](https://github.com/auth0/auth0-java/blob/master/reference.md)
35+
36+
37+
### Migration Example
38+
39+
#### Management API Client Initialization
40+
41+
**Before (v2):**
42+
```java
43+
import com.auth0.client.mgmt.ManagementAPI;
44+
45+
// Using domain and token
46+
ManagementAPI mgmt = ManagementAPI.newBuilder("{YOUR_DOMAIN}", "{YOUR_API_TOKEN}").build();
47+
48+
// Using TokenProvider
49+
TokenProvider tokenProvider = SimpleTokenProvider.create("{YOUR_API_TOKEN}");
50+
ManagementAPI mgmt = ManagementAPI.newBuilder("{YOUR_DOMAIN}", tokenProvider).build();
51+
```
52+
53+
**After (v3 – Standard Token-Based):**
54+
```java
55+
import com.auth0.client.mgmt.ManagementApi;
56+
57+
ManagementApi client = ManagementApi
58+
.builder()
59+
.url("https://{YOUR_DOMAIN}/api/v2")
60+
.token("{YOUR_API_TOKEN}")
61+
.build();
62+
```
63+
64+
**Note**: The Authentication API remains supported, with deprecated APIs removed.
65+
A complete migration guide is available at [MIGRATION_GUIDE](MIGRATION_GUIDE.md).
866

967
## [3.0.0-beta.0](https://github.com/auth0/auth0-java/tree/3.0.0-beta.0) (2025-12-18)
1068
[Full Changelog](https://github.com/auth0/auth0-java/compare/2.27.0...3.0.0-beta.0)

0 commit comments

Comments
 (0)