Documentation navigation

Auth

Sign in with a social provider

GET/auth/authorize

Starts an OAuth sign-in flow with an external provider.

Parameters

SignInWithOAuthRequest
provider'apple' | 'azure' | 'discord' | 'github' | 'gitlab' | 'google' | 'snapchat' | 'twitch' | 'twitter' | 'x'
The external identity provider.
options.redirectTo?string
Callback destination after authorization.
options.scopes?string
Provider scopes to request.
options.queryParams?Record<string, string>
Additional provider query parameters.
options.skipBrowserRedirect?boolean
Return the URL without navigating the browser.

Returns

provider'apple' | 'azure' | 'discord' | 'github' | 'gitlab' | 'google' | 'snapchat' | 'twitch' | 'twitter' | 'x'
urlstring | null