Begin an OAuth sign-in and return the provider authorization URL

Returns a signed provider authorization URL instead of redirecting directly, so clients choose between following it (browser) or opening it in a web session (React Native). Every redirect-bearing field is validated against trustedOrigins; custom schemes (e.g. myapp://, exp://) are allowed only when configured.

POST/api/auth/sign-in/social

Request body

requiredapplication/json

providerstringrequired

callbackURLstring

App URL to land on after the provider round-trip.

errorURLstring

newUserURLstring

requestSignUpboolean

linkboolean

Link this provider account to the signed-in user.

landingVerifierstring

Cookie-bound landing verifier for token-mode flows. The SSR boundary substitutes the cookie value; never trust a body-supplied value when the cookie exists.

Responses

200

Signed provider URL to navigate to.

successboolean

Allowed:true

urlstring<uri>

redirectboolean

400

Unknown provider or an untrusted redirect parameter (invalid_callback_url, invalid_error_url, invalid_new_user_url).

successbooleanrequired

Allowed:false

reasonstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Bodyapplication/json

providerstring*callbackURLstringApp URL to land on after the provider round-trip.errorURLstringnewUserURLstringrequestSignUpbooleanlinkbooleanLink this provider account to the signed-in user.landingVerifierstringCookie-bound landing verifier for token-mode flows. The SSR boundary substitutes the cookie value; never trust a body-supplied value when the cookie exists.

Request

curl -X POST 'https://your-deployment.convex.site/api/auth/sign-in/social' \
  -H 'Content-Type: application/json' \
  -d '{
  "provider": "google",
  "callbackURL": "string",
  "errorURL": "string",
  "newUserURL": "string",
  "requestSignUp": true,
  "link": true,
  "landingVerifier": "string"
}'

const response = await fetch("https://your-deployment.convex.site/api/auth/sign-in/social", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"provider\": \"google\",\n  \"callbackURL\": \"string\",\n  \"errorURL\": \"string\",\n  \"newUserURL\": \"string\",\n  \"requestSignUp\": true,\n  \"link\": true,\n  \"landingVerifier\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://your-deployment.convex.site/api/auth/sign-in/social",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"provider\": \"google\",\n  \"callbackURL\": \"string\",\n  \"errorURL\": \"string\",\n  \"newUserURL\": \"string\",\n  \"requestSignUp\": true,\n  \"link\": true,\n  \"landingVerifier\": \"string\"\n}",
)

Response

{
  "success": true,
  "url": "http://example.com",
  "redirect": true
}

{
  "success": false,
  "reason": "invalid_body"
}