Google OAuth login may not work in in-app browsers (IABs), such as those embedded in social apps,
due to Google’s restrictions in these
environments.
Other OAuth providers are generally unaffected.
To authenticate your users with Privy’s out of the box UIs, check out UI components here.
initOAuth from the useLoginWithOAuth hook to trigger the OAuth login flow.The OAuth provider to use for authentication. Valid values are:
'google', 'apple', 'twitter',
'github', 'discord', 'linkedin', 'spotify', 'tiktok', 'instagram', 'line'.If set to true, the OAuth flow will only allow users to log in with existing accounts and prevent new account creation.
Usage
Tracking Flow State
Track the state of the OAuth flow via thestate variable returned by the useLoginWithOAuth hook.The current state of the OAuth flow.
The error that occurred during the OAuth flow (only present when status is ‘error’).
Callbacks
You can optionally pass callbacks to theuseLoginWithOAuth hook to run custom logic after a successful login or to handle errors.onComplete
Parameters
The user object returned after successful login.
Whether the user is a new user or an existing user.
Whether the user was already authenticated before the OAuth flow.
The login method used (‘google’, ‘apple’, etc.).
The linked account if the user was already authenticated.
onError
Parameters
The error that occurred during the OAuth flow.
Example with Callbacks
Security
We recommend configuring allowed OAuth redirect URLs to restrict where users can be redirected after they log in with an external OAuth provider. Learn more here!Accessing OAuth tokens
For any OAuth login method for which you configure your own credentials, you are able to have the user’s OAuth and Refresh access tokens accessible to your app by toggling Return OAuth tokens and making use of the useOAuthTokens hook.Resources
React starter repo
Get started with React and Privy.
Next.js starter repo
Get started with Next.js and Privy.
Whitelabel starter repo
Get started with a whitelabel Privy integration.

