Flutter: Sign in a user through OAuth

Signs the user in using third-party OAuth providers.

• This method is used for signing in using a third-party provider.
• Supabase supports many different third-party providers.

Parameters

• provider

  (Required)

  The OAuth provider to use for signing in.

• redirectTo

  (Optional)

  The URL to redirect the user to after they sign in with the third-party provider.

• scopes

  (Optional)

  A list of scopes to request from the third-party provider.

• authScreenLaunchMode

  (Optional)

  The launch mode for the auth screen. Defaults to `LaunchMode.platformDefault`.

• queryParams

  (Optional)

  Additional query parameters to be passed to the OAuth flow.

Examples

Sign in using a third-party provider

await supabase.auth.signInWithOAuth(
  OAuthProvider.github,
  redirectTo: kIsWeb ? null : 'my.scheme://my-host', // Optionally set the redirect link to bring back the user via deeplink.
  authScreenLaunchMode:
      kIsWeb ? LaunchMode.platformDefault : LaunchMode.externalApplication, // Launch the auth screen in a new webview on mobile.
);

With `redirectTo`

await supabase.auth.signInWithOAuth(
  OAuthProvider.github,
  redirectTo: kIsWeb ? null : 'io.supabase.flutter://reset-callback/',
);

With scopes

await supabase.auth.signInWithOAuth(
  OAuthProvider.github,
  scopes: 'repo gist notifications'
);
...
// after user comes back from signin flow

final Session? session = supabase.auth.currentSession;
final String? oAuthToken = session?.providerToken;