Skip to main content
function signInWithOAuth(providerType: OAuth2ProviderType, options?: {
  idempotencyKey?: string;
}): Promise<void>;
Initiates the sign in flow with an OAuth provider (Google, Apple, Telegram, and X are currently supported). In a web application, this will redirect the user to the OAuth provider’s sign in page. This sign in method is not yet supported on mobile.

​
Parameters

ParameterTypeDescription
providerTypeOAuth2ProviderTypeThe type of OAuth provider to sign in with.
options?{ idempotencyKey?: string; }Optional options for the sign in.
options.idempotencyKey?stringOptional idempotency key for safe retries.

​
Returns

Promise<void> The result of the sign in.

​
Examples

// Google
try {
 void signInWithOAuth("google");
} catch (error) {
  console.error("Failed to sign in with Google:", error);
}

// Apple
try {
 void signInWithOAuth("apple");
} catch (error) {
 console.error("Failed to sign in with Apple:", error);
}

// X
try {
 void signInWithOAuth("x");
} catch (error) {
 console.error("Failed to sign in with X:", error);
}