Skip to main content
POST
Sign in with a social provider

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token.

Body

application/json
provider
required
Available options:
apple,
atlassian,
cognito,
discord,
facebook,
figma,
github,
microsoft,
google,
huggingface,
slack,
spotify,
twitch,
twitter,
dropbox,
kick,
linear,
linkedin,
gitlab,
tiktok,
reddit,
roblox,
salesforce,
vk,
zoom,
notion,
kakao,
naver,
line,
paybin,
paypal,
polar,
railway,
vercel,
wechat
callbackURL
string

Callback URL to redirect to after the user has signed in

newUserCallbackURL
string
errorCallbackURL
string

Callback URL to redirect to if an error happens

disableRedirect
boolean

Disable automatic redirection to the provider. Useful for handling the redirection yourself

idToken
object
scopes
string[]

Array of scopes to request from the provider. This will override the default scopes passed.

requestSignUp
boolean

Explicitly request sign-up. Useful when disableImplicitSignUp is true for this provider

loginHint
string

The login hint to use for the authorization code request

additionalData
object

Response

Success - Returns session details (idToken branch) or an authorize URL (redirect branch)

Returns session details when idToken is provided, or an authorize URL otherwise

redirect
boolean
required
token
string
user
object
url
string