Skip to content

Commit 6e8521c

Browse files
docs: fix README drift — broken DPoP link, stale What's New banner, stale migration notice (#878)
Co-authored-by: Sanchit Mehta <sanchitmehtagit@users.noreply.github.com>
1 parent 607702a commit 6e8521c

2 files changed

Lines changed: 5 additions & 32 deletions

File tree

auth0_flutter/EXAMPLES.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -58,29 +58,6 @@
5858

5959
## 📱 Web Authentication
6060

61-
- [Log out](#log-out)
62-
- [Sign up](#sign-up)
63-
- [Adding an audience](#adding-an-audience)
64-
- [Adding scopes](#adding-scopes)
65-
- [Adding custom parameters](#adding-custom-parameters)
66-
- [ID token validation](#id-token-validation)
67-
- [Using `SFSafariViewController` (iOS only)](#using-sfsafariviewcontroller-ios-only)
68-
- [1. Configure a custom URL scheme](#1-configure-a-custom-url-scheme)
69-
- [2. Capture the callback URL](#2-capture-the-callback-url)
70-
- [Using Partial Custom Tabs (Android only)](#using-partial-custom-tabs-android-only)
71-
- [Errors](#errors)
72-
- [Android: Custom schemes](#android-custom-schemes)
73-
- [🪟 Windows Web Authentication](#-windows-web-authentication)
74-
- [Prerequisites](#prerequisites)
75-
- [1. Install vcpkg and native dependencies](#1-install-vcpkg-and-native-dependencies)
76-
- [2. Configure your app's CMakeLists.txt](#2-configure-your-apps-cmakeliststxt)
77-
- [3. Register the custom URL scheme (protocol handler)](#3-register-the-custom-url-scheme-protocol-handler)
78-
- [4. Update the runner (main.cpp)](#4-update-the-runner-maincpp)
79-
- [Login](#login)
80-
- [Logout](#logout)
81-
82-
---
83-
8461
### Log out
8562

8663
Logging the user out involves clearing the Universal Login session cookie and then deleting the user's credentials from your app.
@@ -767,7 +744,7 @@ if (userProfile != null) {
767744

768745
### Custom implementations
769746

770-
flutter_auth0 exposes a built-in, default Credentials Manager implementation through the `credentialsManager` property. You can pass your own implementation to the `Auth0` constructor. If you're using Web Auth, this implementation will be used to store the user's credentials after login and delete them after logout.
747+
auth0_flutter exposes a built-in, default Credentials Manager implementation through the `credentialsManager` property. You can pass your own implementation to the `Auth0` constructor. If you're using Web Auth, this implementation will be used to store the user's credentials after login and delete them after logout.
771748

772749
```dart
773750
final customCredentialsManager = CustomCredentialsManager();
@@ -1472,7 +1449,7 @@ try {
14721449

14731450
The My Account API lets authenticated users manage their own multi-factor authentication (MFA) methods — enrolling, confirming, listing, updating, and deleting factors such as phone, email, TOTP, push notifications, and recovery codes. It is available on **mobile (Android/iOS) only**.
14741451

1475-
> 💡 The My Account API must be enabled for your tenant. If it is not yet available on your account, reach out to Auth0 support to get it enabled.
1452+
> 💡 The My Account API requires [Multi-Resource Refresh Tokens (MRRT)](https://auth0.com/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token) to be enabled for your tenant. Contact Auth0 support if MRRT is not yet available on your account.
14761453
14771454
### Obtaining an access token for the My Account API
14781455

auth0_flutter/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,9 @@
99
📚 <a href="#documentation">Documentation</a> • 🚀 <a href="#getting-started">Getting started</a> • 🌐 <a href="#api-reference">API reference</a> • 💬 <a href="#feedback">Feedback</a>
1010
</div>
1111

12-
## What's New: v2.1.0
12+
## What's New: v2.3.0
1313

14-
**auth0_flutter v2.1.0** adds **Windows Desktop** support. You can now use `windowsWebAuthentication()` to authenticate users on Windows using the same PKCE-based flow available on mobile. See the [Windows configuration section](#windows-configure-protocol-handler) below for setup instructions.
15-
16-
## Important Migration Notice: v2.0.0
17-
18-
**auth0_flutter v2.0.0** includes updates to the underlying native Auth0 SDKs to support **DPoP (Demonstrating Proof of Possession)** and other improvements. See the [Migration Guide](https://github.com/auth0/auth0-flutter/blob/main/auth0_flutter/MIGRATION_GUIDE.md) for compatibility requirements and upgrade instructions.
14+
**auth0_flutter v2.3.0** adds **Passkeys** support. You can now authenticate users with passkeys via the `webAuthentication()` flow on Android, iOS, and Web. See the [Auth0 passkeys documentation](https://auth0.com/docs/authenticate/database-connections/passkeys) for setup instructions.
1915

2016
## Documentation
2117

@@ -534,7 +530,7 @@ final auth0Web = Auth0Web(
534530

535531
> **Note:** In most cases, DPoP is managed automatically when `useDPoP: true` is enabled. Manual DPoP APIs are available for advanced use cases where you need direct control over DPoP proof generation.
536532
537-
📖 **For complete DPoP documentation, examples, and troubleshooting, see [DPOP.md](DPOP.md)**
533+
📖 **For complete DPoP documentation, examples, and troubleshooting, see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md)**
538534

539535
### iOS SSO Alert Box
540536

0 commit comments

Comments
 (0)