The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
docs: update Dart passkey docs for authenticator parameter (#47490)
Lukas Klingsbobc1ad74cfee7
diff --git a/apps/docs/content/guides/auth/passkeys.mdx b/apps/docs/content/guides/auth/passkeys.mdxindex 1a732f7cfa7..ce5df61be30 100644--- a/apps/docs/content/guides/auth/passkeys.mdx+++ b/apps/docs/content/guides/auth/passkeys.mdx@@ -136,6 +136,14 @@ await Supabase.initialize(final supabase = Supabase.instance.client;```+`supabase_flutter` performs the server side of the WebAuthn ceremony for you and delegates the platform prompt (FaceID/TouchID/security key) to an authenticator you supply, instead of depending on a passkey plugin directly. Add a passkey plugin to your own app and pass its authenticator to `registerPasskey()` and `signInWithPasskey()`. The [`passkeys`](https://pub.dev/packages/passkeys) plugin's `PasskeyAuthenticator` implements the `PasskeyAuthenticatorInterface` these methods expect (since `passkeys` `2.21.0`), but you can pass any implementation of that interface:++```dart+import 'package:passkeys/authenticator.dart';++final authenticator = PasskeyAuthenticator();+```+Platform setup that the library cannot do for you (Associated Domains on iOS/macOS, Digital Asset Links on Android, and including the [`passkeys`](https://pub.dev/packages/passkeys) web SDK in `index.html` on web) is documented in the `supabase_flutter` package README.</TabPanel>@@ -185,7 +193,7 @@ if (error) {```darttry {- final Passkey passkey = await supabase.auth.registerPasskey();+ final Passkey passkey = await supabase.auth.registerPasskey(authenticator);print('Registered passkey ${passkey.id}');} on AuthException catch (e) {// The Supabase server rejected the credential.@@ -261,7 +269,7 @@ if (error) {```darttry {- final AuthResponse res = await supabase.auth.signInWithPasskey();+ final AuthResponse res = await supabase.auth.signInWithPasskey(authenticator);// res.session and res.user are set; the client also fires AuthChangeEvent.signedInprint('Signed in as ${res.user?.email}');} on AuthException catch (e) {diff --git a/apps/docs/spec/supabase_dart_v2.yml b/apps/docs/spec/supabase_dart_v2.ymlindex 4371c692617..b1592131130 100644--- a/apps/docs/spec/supabase_dart_v2.yml+++ b/apps/docs/spec/supabase_dart_v2.yml@@ -888,12 +888,17 @@ functions:notes: |Signs the user in with a passkey (WebAuthn).- Available on `supabase_flutter` 2.15.0 and later as an extension on `GoTrueClient`.- - Drives the full WebAuthn ceremony end to end: starts the challenge with the Supabase server, prompts the user for biometrics or a security key via the platform passkey API, and verifies the credential with the server.+ - Drives the full WebAuthn ceremony end to end: starts the challenge with the Supabase server, calls the `authenticator` you supply to prompt the user for biometrics or a security key, and verifies the credential with the server.- Does not require an existing session. On success the session is persisted and an `AuthChangeEvent.signedIn` event is fired.+ - `supabase_flutter` does not depend on a passkey plugin directly. Pass an implementation of `PasskeyAuthenticatorInterface`, such as the [`passkeys`](https://pub.dev/packages/passkeys) plugin's `PasskeyAuthenticator` (since `passkeys` `2.21.0`).- For native flows or custom UI, use the lower-level [`auth.passkey`](/docs/reference/dart/auth-passkey-api) namespace instead.- Passkeys are a BETA feature and must be enabled for your project in the Supabase Dashboard under Authentication > Configuration > Passkeys.- Platform setup the library cannot perform (Associated Domains on iOS/macOS, Digital Asset Links on Android, the `passkeys` web SDK on web) is documented in the `supabase_flutter` package README.params:+ - name: authenticator+ isOptional: false+ type: PasskeyAuthenticatorInterface+ description: Performs the platform passkey ceremony (FaceID/TouchID/security key). For example, a `PasskeyAuthenticator` from the `passkeys` package.- name: captchaTokenisOptional: truetype: String@@ -904,7 +909,11 @@ functions:isSpotlight: truecode: |```dart- final AuthResponse res = await supabase.auth.signInWithPasskey();+ import 'package:passkeys/authenticator.dart';++ final authenticator = PasskeyAuthenticator();++ final AuthResponse res = await supabase.auth.signInWithPasskey(authenticator);final Session? session = res.session;final User? user = res.user;```@@ -913,17 +922,27 @@ functions:notes: |Registers a new passkey (WebAuthn credential) for the signed in user.- Available on `supabase_flutter` 2.15.0 and later as an extension on `GoTrueClient`.- - Drives the full WebAuthn ceremony end to end: starts the registration with the Supabase server, prompts the user to create a credential on the device, and verifies it with the server.+ - Drives the full WebAuthn ceremony end to end: starts the registration with the Supabase server, calls the `authenticator` you supply to create a credential on the device, and verifies it with the server.- Requires a signed in (non-anonymous) user. If the user has verified MFA factors, the session has to be at `aal2` to manage passkeys.+ - `supabase_flutter` does not depend on a passkey plugin directly. Pass an implementation of `PasskeyAuthenticatorInterface`, such as the [`passkeys`](https://pub.dev/packages/passkeys) plugin's `PasskeyAuthenticator` (since `passkeys` `2.21.0`).- For native flows or custom UI, use the lower-level [`auth.passkey`](/docs/reference/dart/auth-passkey-api) namespace instead.- Passkeys are a BETA feature and must be enabled for your project in the Supabase Dashboard under Authentication > Configuration > Passkeys.+ params:+ - name: authenticator+ isOptional: false+ type: PasskeyAuthenticatorInterface+ description: Performs the platform passkey ceremony (FaceID/TouchID/security key). For example, a `PasskeyAuthenticator` from the `passkeys` package.examples:- id: register-passkeyname: Register a passkey for the current userisSpotlight: truecode: |```dart- final Passkey passkey = await supabase.auth.registerPasskey();+ import 'package:passkeys/authenticator.dart';++ final authenticator = PasskeyAuthenticator();++ final Passkey passkey = await supabase.auth.registerPasskey(authenticator);```- id: sign-outtitle: 'signOut()'