Class WebAuthFlow

Verifies if the web authentication flow is available on the current device.

Android: Returns true if the user's device has Google Chrome installed, enabled, and supports Google Chrome Auth Tabs, which are required to perform the authentication flow.

iOS: Returns true on iOS 17.4 or later, which is the minimum version supporting HTTPS callbacks in ASWebAuthenticationSession. Returns false on earlier versions.

Successful execution of this method depends on the callback host being verifiably associated with your app on each platform:

Android: the package_name and sha256_cert_fingerprints values in the target domain's assetlinks.json must match those belonging to your app. For testing, running adb shell pm set-app-links --package [PACKAGE_NAME] 2 all temporarily bypasses those requirements.

iOS: the callback host must be declared in the app's Associated Domains entitlement (applinks:[HOST]) and served by an apple-app-site-association file on that domain.

Starts a web-based authentication flow, opening the start URL in a secure browser tab. The flow completes when the browser redirects to the callback path on the host domain.

Platform availability: Android and iOS (17.4 or later). Always check isAvailable before calling this method, as this method throws when the flow is unavailable on the device.

Example:

const modules = await Eitri.modules();
const isAvailable = modules?.webAuth?.isAvailable;
if (!isAvailable) {
  console.log("Web auth flow is not available on this device.")
  return
}

const available = await isAvailable()
if (!available) {
  console.log("Web auth flow is not available on this device.")
  return
}

const startAuthFlow = modules?.webAuth?.startAuthFlow;
if (!startAuthFlow) return;
const result = await startAuthFlow({
  startUrl: "https://www.example.com/oauth/authorize?client_id=abc&redirect_uri=...",
  redirectHost: "www.example.com",
  redirectPath: "/oauth/callback"
})
Copy