--- title: Capacitor Firebase Auth Plugin for Android, iOS & Web description: Unofficial Capacitor plugin for Firebase Authentication SDK to authenticate users with email, phone, and social providers. tags: - Android - iOS - Web search: boost: 2 faq: true github_repo: capawesome-team/capacitor-firebase npm_package: "@capacitor-firebase/authentication" --- # Capacitor Firebase Authentication Plugin Unofficial Capacitor plugin for [Firebase Authentication](https://firebase.google.com/docs/auth).[^1]
Deliver Live Updates to your Capacitor app with Capawesome Cloud
## Use Cases The Firebase Authentication plugin is typically used to handle the entire sign-in flow of an app, for example: - **Social logins**: Sign in users natively with Apple, Google, Facebook, Microsoft, GitHub, Twitter, Yahoo, Play Games, or Game Center. - **Email-based authentication**: Register and sign in users with email and password, or send them a passwordless sign-in link. - **Phone number sign-in**: Verify users with an SMS code sent to their phone number. - **Guest access**: Let users try your app with anonymous sign-in and link a permanent account later. - **Custom backends**: Sign in with custom tokens or OpenID Connect and retrieve ID tokens to authenticate requests to your own backend. ## Compatibility | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | >=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | | 5.x.x | 5.x.x | Deprecated | | 1.x.x | 4.x.x | Deprecated | ## Guides - [Firebase Authentication in Capacitor: Setup & Best Practices](https://capawesome.io/blog/capacitor-firebase-authentication-guide/): Setup and best practices for sign-in flows with this plugin. ## Installation You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: ```bash npx skills add capawesome-team/skills --skill capacitor-plugins ``` Then use the following prompt: ``` Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/authentication` plugin in my project. ``` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: ```bash npm install @capacitor-firebase/authentication firebase npx cap sync ``` Add Firebase to your project if you haven't already ([Android](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) / [iOS](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) / [Web](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)). On **iOS**, verify that this function is included in your app's `AppDelegate.swift`: ```swift func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool { return ApplicationDelegateProxy.shared.application(app, open: url, options: options) } ``` **Attention**: If you use this plugin on **iOS** in combination with `@capacitor-firebase/messaging`, then add the following to your app's `AppDelegate.swift`: ```diff + import FirebaseAuth func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool { + if Auth.auth().canHandle(url) { + return true + } return ApplicationDelegateProxy.shared.application(app, open: url, options: options) } ``` The further installation steps depend on the selected authentication method: - [Apple Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-apple.md) - [Facebook Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-facebook.md) - [Game Center Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-game-center.md) - [GitHub Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-github.md) - [Google Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-google.md) - [Microsoft Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-microsoft.md) - [OpenID Connect Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-oidc.md) - [Play Games Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-play-games.md) - [Twitter Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-twitter.md) - [Yahoo Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-yahoo.md) - [Anonymous Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-anonymous.md) - [Email Link Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-email-link.md) - [Phone Number Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-phone.md) - [Custom Token Sign-In](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-custom-token.md) **Attention**: Please note that this plugin uses third-party SDKs to offer native sign-in. These SDKs can initialize on their own and collect various data. For more information, see [Third-Party SDKs](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/third-party-sdks.md). ### iOS #### Swift Package Manager Add the following to your `capacitor.config.json` (or `capacitor.config.ts`) to avoid a [SwiftPM package identity collision](https://github.com/capawesome-team/capacitor-firebase/issues/959): ```json { "experimental": { "ios": { "spm": { "packageOptions": { "@capacitor-firebase/authentication": { "symlink": true } } } } } } ``` **Attention**: SPM `packageOptions` support requires Capacitor CLI **8.4.0+**. ##### Package traits The GoogleSignIn and Facebook SDKs are optional and are included by default via the `Google` and `Facebook` package traits. If you do not use these providers, disable the corresponding trait so that the SDK is not linked into your app: ```json { "experimental": { "ios": { "spm": { "swiftToolsVersion": "6.1", "packageTraits": { "@capacitor-firebase/authentication": ["Google"] } } } } } ``` Listing traits explicitly replaces the defaults, so only the traits you list are enabled. The example above keeps GoogleSignIn and excludes the Facebook SDK. Use the `Lite` trait to exclude both: ```json { "experimental": { "ios": { "spm": { "swiftToolsVersion": "6.1", "packageTraits": { "@capacitor-firebase/authentication": ["Lite"] } } } } } ``` These traits are the Swift Package Manager equivalent of the `CapacitorFirebaseAuthentication/Google`, `CapacitorFirebaseAuthentication/Facebook` and `CapacitorFirebaseAuthentication/Lite` CocoaPods subspecs. Calling a sign-in method of a provider whose SDK is excluded rejects with an error. **Attention**: SPM trait support requires Capacitor CLI **8.3.0+** and Xcode **16.3+** (Swift 6.1+). ## Configuration These configuration values are available: | Prop | Type | Description | Default | Since | | -------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | **`authDomain`** | string | Configure the custom auth domain you want to use. Only available for Android and iOS. | | 7.3.0 | | **`skipNativeAuth`** | boolean | Configure whether the plugin should skip the native authentication. Only needed if you want to use the Firebase JavaScript SDK. This configuration option has no effect on Firebase account linking. **Note that the plugin may behave differently across the platforms.** Only available for Android and iOS. | false | 0.1.0 | | **`providers`** | string[] | Configure the providers that should be loaded by the plugin. Possible values: `["apple.com", "facebook.com", "gc.apple.com", "github.com", "google.com", "microsoft.com", "playgames.google.com", "twitter.com", "yahoo.com", "phone"]` Only available for Android and iOS. | [] | 0.1.0 | ### Examples In `capacitor.config.json`: ```json { "plugins": { "FirebaseAuthentication": { "authDomain": undefined, "skipNativeAuth": false, "providers": ["apple.com", "facebook.com"] } } } ``` In `capacitor.config.ts`: ```ts /// import { CapacitorConfig } from '@capacitor/cli'; const config: CapacitorConfig = { plugins: { FirebaseAuthentication: { authDomain: undefined, skipNativeAuth: false, providers: ["apple.com", "facebook.com"], }, }, }; export default config; ``` ## Firebase JavaScript SDK [Here](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/firebase-js-sdk.md) you can find information on how to use the plugin with the Firebase JS SDK. ## Demo A working example can be found here: [robingenz/capacitor-firebase-authentication-demo](https://github.com/robingenz/capacitor-firebase-authentication-demo) ## Starter templates The following starter templates are available: - [Ionstarter Angular Firebase](https://ionstarter.dev/) ## Usage The following examples show how to sign in with email and password, social providers, a phone number, an email link, anonymously, and custom tokens, as well as how to manage the current user, reset passwords, verify and update email addresses, set the language, sign out, delete the user, and use the Firebase Emulator. ### Sign up and sign in with email and password Create a new user account with email and password and sign the user in with those credentials: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const createUserWithEmailAndPassword = async () => { const result = await FirebaseAuthentication.createUserWithEmailAndPassword({ email: 'mail@example.com', password: '1234', }); return result.user; }; const signInWithEmailAndPassword = async () => { const result = await FirebaseAuthentication.signInWithEmailAndPassword({ email: 'mail@example.com', password: '1234', }); return result.user; }; ``` ### Sign in with a social provider Sign in users natively with providers such as Apple, Google, Facebook, GitHub, Microsoft, Twitter or Yahoo. Each provider requires the setup steps linked in the [Installation](#installation) section. Game Center sign-in is only available on iOS and Play Games sign-in is only available on Android: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const signInWithApple = async () => { const result = await FirebaseAuthentication.signInWithApple(); return result.user; }; const signInWithFacebook = async () => { const result = await FirebaseAuthentication.signInWithFacebook(); return result.user; }; const signInWithGameCenter = async () => { const result = await FirebaseAuthentication.signInWithGameCenter(); return result.user; }; const signInWithGithub = async () => { const result = await FirebaseAuthentication.signInWithGithub(); return result.user; }; const signInWithGoogle = async () => { const result = await FirebaseAuthentication.signInWithGoogle(); return result.user; }; const signInWithMicrosoft = async () => { const result = await FirebaseAuthentication.signInWithMicrosoft(); return result.user; }; const signInWithPlayGames = async () => { const result = await FirebaseAuthentication.signInWithPlayGames(); return result.user; }; const signInWithTwitter = async () => { const result = await FirebaseAuthentication.signInWithTwitter(); return result.user; }; const signInWithYahoo = async () => { const result = await FirebaseAuthentication.signInWithYahoo(); return result.user; }; ``` ### Sign in with a phone number Start the phone number sign-in flow, which sends an SMS code to the user, and confirm the code with `confirmVerificationCode(...)`. Only available on Android and iOS: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const signInWithPhoneNumber = async () => { return new Promise(async resolve => { // Attach `phoneCodeSent` listener to be notified as soon as the SMS is sent await FirebaseAuthentication.addListener('phoneCodeSent', async event => { // Ask the user for the SMS code const verificationCode = window.prompt( 'Please enter the verification code that was sent to your mobile device.', ); // Confirm the verification code const result = await FirebaseAuthentication.confirmVerificationCode({ verificationId: event.verificationId, verificationCode, }); resolve(result.user); }); // Attach `phoneVerificationCompleted` listener to be notified if phone verification could be finished automatically await FirebaseAuthentication.addListener( 'phoneVerificationCompleted', async event => { resolve(event.result.user); }, ); // Start sign in with phone number and send the SMS await FirebaseAuthentication.signInWithPhoneNumber({ phoneNumber: '123456789', }); }); }; ``` ### Sign in with an email link Send a passwordless sign-in link to the user's email address and complete the sign-in once the link is opened: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const sendSignInLinkToEmail = async () => { const email = 'mail@example.com'; await FirebaseAuthentication.sendSignInLinkToEmail({ email, actionCodeSettings: { // URL you want to redirect back to. The domain (www.example.com) for this // URL must be in the authorized domains list in the Firebase Console. url: 'https://www.example.com/finishSignUp?cartId=1234', // This must be true. handleCodeInApp: true, iOS: { bundleId: 'com.example.ios', }, android: { packageName: 'com.example.android', installApp: true, minimumVersion: '12', }, dynamicLinkDomain: 'example.page.link', }, }); // The link was successfully sent. Inform the user. // Save the email locally so you don't need to ask the user for it again // if they open the link on the same device. window.localStorage.setItem('emailForSignIn', email); }; const signInWithEmailLink = async () => { // Get the email if available. This should be available if the user completes // the flow on the same device where they started it. const emailLink = window.location.href; // Confirm the link is a sign-in with email link. const { isSignInWithEmailLink } = await FirebaseAuthentication.isSignInWithEmailLink({ emailLink, }); if (!isSignInWithEmailLink) { return; } let email = window.localStorage.getItem('emailForSignIn'); if (!email) { // User opened the link on a different device. To prevent session fixation // attacks, ask the user to provide the associated email again. email = window.prompt('Please provide your email for confirmation.'); } // The client SDK will parse the code from the link for you. const result = await FirebaseAuthentication.signInWithEmailLink({ email, emailLink, }); // Clear email from storage. window.localStorage.removeItem('emailForSignIn'); return result.user; }; ``` ### Sign in anonymously Sign in a user anonymously, for example to let users try your app before creating an account: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const signInAnonymously = async () => { const result = await FirebaseAuthentication.signInAnonymously(); return result.user; }; ``` ### Sign in with a custom token or OpenID Connect Authenticate against your own backend with a custom token or use any OpenID Connect provider: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const signInWithCustomToken = async () => { const result = await FirebaseAuthentication.signInWithCustomToken({ token: '1234', }); return result.user; }; const signInWithOpenIdConnect = async () => { const result = await FirebaseAuthentication.signInWithOpenIdConnect({ providerId: 'oidc.example.com', }); return result.user; }; ``` ### Get the current user and ID token Retrieve the currently signed-in user, their ID token, or the result of a pending authentication operation. The `getPendingAuthResult()` method is only available on Android: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const getCurrentUser = async () => { const result = await FirebaseAuthentication.getCurrentUser(); return result.user; }; const getIdToken = async () => { const currentUser = await getCurrentUser(); if (!currentUser) { return; } const result = await FirebaseAuthentication.getIdToken(); return result.token; }; const getPendingAuthResult = async () => { const result = await FirebaseAuthentication.getPendingAuthResult(); return result.user; }; ``` ### Send and confirm a password reset Send a password reset email to the user and confirm the password reset with the received out-of-band code: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const sendPasswordResetEmail = async () => { await FirebaseAuthentication.sendPasswordResetEmail({ email: 'mail@example.com', }); }; const confirmPasswordReset = async () => { await FirebaseAuthentication.confirmPasswordReset({ oobCode: '1234', newPassword: '4321', }); }; ``` ### Verify the user's email address Send a verification email to the currently signed-in user and apply the received out-of-band code: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const sendEmailVerification = async () => { const currentUser = await getCurrentUser(); if (!currentUser) { return; } await FirebaseAuthentication.sendEmailVerification(); }; const applyActionCode = async () => { await FirebaseAuthentication.applyActionCode({ oobCode: '1234' }); }; ``` ### Update the user's email or password Update the email address or password of the currently signed-in user. With `verifyBeforeUpdateEmail(...)`, the new email address is verified before it is updated: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const updateEmail = async () => { const currentUser = await getCurrentUser(); if (!currentUser) { return; } await FirebaseAuthentication.updateEmail({ newEmail: 'new.mail@example.com', }); }; const verifyBeforeUpdateEmail = async () => { const currentUser = await getCurrentUser(); if (!currentUser) { return; } await FirebaseAuthentication.verifyBeforeUpdateEmail({ newEmail: 'new.mail@example.com', actionCodeSettings: { url: 'https://www.example.com/cart?email=user@example.com&cartId=123', iOS: { bundleId: 'com.example.ios' }, android: { packageName: 'com.example.android', installApp: true, minimumVersion: '12' }, handleCodeInApp: true } }); }; const updatePassword = async () => { const currentUser = await getCurrentUser(); if (!currentUser) { return; } await FirebaseAuthentication.updatePassword({ newPassword: '4321', }); }; ``` ### Look up sign-in methods for an email Fetch the sign-in methods that are available for an email address: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const fetchSignInMethodsForEmail = async () => { const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'mail@example.tld', }); return result.signInMethods; }; ``` ### Set the language Set the language code to use, or apply the current app language: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const setLanguageCode = async () => { await FirebaseAuthentication.setLanguageCode({ languageCode: 'en-US' }); }; const useAppLanguage = async () => { await FirebaseAuthentication.useAppLanguage(); }; ``` ### Sign out and delete the user Sign out the current user or permanently delete the user account: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const signOut = async () => { await FirebaseAuthentication.signOut(); }; const deleteUser = async () => { await FirebaseAuthentication.deleteUser(); }; ``` ### Use the Firebase Emulator Connect the plugin to a local [Firebase Emulator](https://firebase.google.com/docs/emulator-suite) instance during development: ```typescript import { FirebaseAuthentication } from '@capacitor-firebase/authentication'; const useEmulator = async () => { await FirebaseAuthentication.useEmulator({ host: '10.0.2.2', port: 9099, }); }; ``` ## API * [`applyActionCode(...)`](#applyactioncode) * [`confirmPasswordReset(...)`](#confirmpasswordreset) * [`confirmVerificationCode(...)`](#confirmverificationcode) * [`createUserWithEmailAndPassword(...)`](#createuserwithemailandpassword) * [`deleteUser()`](#deleteuser) * [`fetchSignInMethodsForEmail(...)`](#fetchsigninmethodsforemail) * [`getCurrentUser()`](#getcurrentuser) * [`getPendingAuthResult()`](#getpendingauthresult) * [`getIdToken(...)`](#getidtoken) * [`getIdTokenResult(...)`](#getidtokenresult) * [`getRedirectResult()`](#getredirectresult) * [`getTenantId()`](#gettenantid) * [`isSignInWithEmailLink(...)`](#issigninwithemaillink) * [`linkWithApple(...)`](#linkwithapple) * [`linkWithEmailAndPassword(...)`](#linkwithemailandpassword) * [`linkWithEmailLink(...)`](#linkwithemaillink) * [`linkWithFacebook(...)`](#linkwithfacebook) * [`linkWithGameCenter(...)`](#linkwithgamecenter) * [`linkWithGithub(...)`](#linkwithgithub) * [`linkWithGoogle(...)`](#linkwithgoogle) * [`linkWithMicrosoft(...)`](#linkwithmicrosoft) * [`linkWithOpenIdConnect(...)`](#linkwithopenidconnect) * [`linkWithPhoneNumber(...)`](#linkwithphonenumber) * [`linkWithPlayGames(...)`](#linkwithplaygames) * [`linkWithTwitter(...)`](#linkwithtwitter) * [`linkWithYahoo(...)`](#linkwithyahoo) * [`reload()`](#reload) * [`revokeAccessToken(...)`](#revokeaccesstoken) * [`sendEmailVerification(...)`](#sendemailverification) * [`sendPasswordResetEmail(...)`](#sendpasswordresetemail) * [`sendSignInLinkToEmail(...)`](#sendsigninlinktoemail) * [`setLanguageCode(...)`](#setlanguagecode) * [`setPersistence(...)`](#setpersistence) * [`setTenantId(...)`](#settenantid) * [`signInAnonymously()`](#signinanonymously) * [`signInWithApple(...)`](#signinwithapple) * [`signInWithCustomToken(...)`](#signinwithcustomtoken) * [`signInWithEmailAndPassword(...)`](#signinwithemailandpassword) * [`signInWithEmailLink(...)`](#signinwithemaillink) * [`signInWithFacebook(...)`](#signinwithfacebook) * [`signInWithGameCenter(...)`](#signinwithgamecenter) * [`signInWithGithub(...)`](#signinwithgithub) * [`signInWithGoogle(...)`](#signinwithgoogle) * [`signInWithMicrosoft(...)`](#signinwithmicrosoft) * [`signInWithOpenIdConnect(...)`](#signinwithopenidconnect) * [`signInWithPhoneNumber(...)`](#signinwithphonenumber) * [`signInWithPlayGames(...)`](#signinwithplaygames) * [`signInWithTwitter(...)`](#signinwithtwitter) * [`signInWithYahoo(...)`](#signinwithyahoo) * [`signOut()`](#signout) * [`unlink(...)`](#unlink) * [`updateEmail(...)`](#updateemail) * [`updatePassword(...)`](#updatepassword) * [`updateProfile(...)`](#updateprofile) * [`useAppLanguage()`](#useapplanguage) * [`useEmulator(...)`](#useemulator) * [`verifyBeforeUpdateEmail(...)`](#verifybeforeupdateemail) * [`checkAppTrackingTransparencyPermission()`](#checkapptrackingtransparencypermission) * [`requestAppTrackingTransparencyPermission()`](#requestapptrackingtransparencypermission) * [`addListener('authStateChange', ...)`](#addlistenerauthstatechange-) * [`addListener('idTokenChange', ...)`](#addlisteneridtokenchange-) * [`addListener('phoneVerificationCompleted', ...)`](#addlistenerphoneverificationcompleted-) * [`addListener('phoneVerificationFailed', ...)`](#addlistenerphoneverificationfailed-) * [`addListener('phoneCodeSent', ...)`](#addlistenerphonecodesent-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) * [Enums](#enums) ### applyActionCode(...) ```typescript applyActionCode(options: ApplyActionCodeOptions) => Promise ``` Applies a verification code sent to the user by email. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | ApplyActionCodeOptions | **Since:** 0.2.2 -------------------- ### confirmPasswordReset(...) ```typescript confirmPasswordReset(options: ConfirmPasswordResetOptions) => Promise ``` Completes the password reset process. | Param | Type | | ------------- | ----------------------------------------------------------------------------------- | | **`options`** | ConfirmPasswordResetOptions | **Since:** 0.2.2 -------------------- ### confirmVerificationCode(...) ```typescript confirmVerificationCode(options: ConfirmVerificationCodeOptions) => Promise ``` Finishes the phone number verification process. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | **`options`** | ConfirmVerificationCodeOptions | **Returns:** Promise<SignInResult> **Since:** 5.0.0 -------------------- ### createUserWithEmailAndPassword(...) ```typescript createUserWithEmailAndPassword(options: CreateUserWithEmailAndPasswordOptions) => Promise ``` Creates a new user account with email and password. If the new account was created, the user is signed in automatically. | Param | Type | | ------------- | ------------------------------------------------------------------------------------------------------- | | **`options`** | CreateUserWithEmailAndPasswordOptions | **Returns:** Promise<SignInResult> **Since:** 0.2.2 -------------------- ### deleteUser() ```typescript deleteUser() => Promise ``` Deletes and signs out the user. **Since:** 1.3.0 -------------------- ### fetchSignInMethodsForEmail(...) ```typescript fetchSignInMethodsForEmail(options: FetchSignInMethodsForEmailOptions) => Promise ``` Fetches the sign-in methods for an email address. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------------- | | **`options`** | FetchSignInMethodsForEmailOptions | **Returns:** Promise<FetchSignInMethodsForEmailResult> **Since:** 6.0.0 -------------------- ### getCurrentUser() ```typescript getCurrentUser() => Promise ``` Fetches the currently signed-in user. **Returns:** Promise<GetCurrentUserResult> **Since:** 0.1.0 -------------------- ### getPendingAuthResult() ```typescript getPendingAuthResult() => Promise ``` Returns the `SignInResult` if your app launched a web sign-in flow and the OS cleans up the app while in the background. Only available for Android. **Returns:** Promise<SignInResult> **Since:** 6.0.0 -------------------- ### getIdToken(...) ```typescript getIdToken(options?: GetIdTokenOptions | undefined) => Promise ``` Fetches the Firebase Auth ID Token for the currently signed-in user. | Param | Type | | ------------- | --------------------------------------------------------------- | | **`options`** | GetIdTokenOptions | **Returns:** Promise<GetIdTokenResult> **Since:** 0.1.0 -------------------- ### getIdTokenResult(...) ```typescript getIdTokenResult(options?: GetIdTokenResultOptions | undefined) => Promise ``` Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service. | Param | Type | | ------------- | --------------------------------------------------------------------------- | | **`options`** | GetIdTokenResultOptions | **Returns:** Promise<GetIdTokenResultResult> **Since:** 7.4.0 -------------------- ### getRedirectResult() ```typescript getRedirectResult() => Promise ``` Returns the `SignInResult` from the redirect-based sign-in flow. If sign-in was unsuccessful, fails with an error. If no redirect operation was called, returns a `SignInResult` with a null user. Only available for Web. **Returns:** Promise<SignInResult> **Since:** 1.3.0 -------------------- ### getTenantId() ```typescript getTenantId() => Promise ``` Get the tenant id. **Returns:** Promise<GetTenantIdResult> **Since:** 1.1.0 -------------------- ### isSignInWithEmailLink(...) ```typescript isSignInWithEmailLink(options: IsSignInWithEmailLinkOptions) => Promise ``` Checks if an incoming link is a sign-in with email link suitable for `signInWithEmailLink`. | Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | **`options`** | IsSignInWithEmailLinkOptions | **Returns:** Promise<IsSignInWithEmailLinkResult> **Since:** 1.1.0 -------------------- ### linkWithApple(...) ```typescript linkWithApple(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Apple authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithEmailAndPassword(...) ```typescript linkWithEmailAndPassword(options: LinkWithEmailAndPasswordOptions) => Promise ``` Links the user account with Email authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------------------------- | | **`options`** | LinkWithEmailAndPasswordOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithEmailLink(...) ```typescript linkWithEmailLink(options: LinkWithEmailLinkOptions) => Promise ``` Links the user account with Email authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ----------------------------------------------------------------------------- | | **`options`** | LinkWithEmailLinkOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithFacebook(...) ```typescript linkWithFacebook(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Facebook authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithGameCenter(...) ```typescript linkWithGameCenter(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Game Center authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. Only available for iOS. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.3.0 -------------------- ### linkWithGithub(...) ```typescript linkWithGithub(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with GitHub authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithGoogle(...) ```typescript linkWithGoogle(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Google authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithMicrosoft(...) ```typescript linkWithMicrosoft(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Microsoft authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithOpenIdConnect(...) ```typescript linkWithOpenIdConnect(options: LinkWithOpenIdConnectOptions) => Promise ``` Links the user account with an OpenID Connect provider. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | **`options`** | SignInWithOpenIdConnectOptions | **Returns:** Promise<SignInResult> **Since:** 6.1.0 -------------------- ### linkWithPhoneNumber(...) ```typescript linkWithPhoneNumber(options: LinkWithPhoneNumberOptions) => Promise ``` Links the user account with Phone Number authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. Use the `phoneVerificationCompleted` listener to be notified when the verification is completed. Use the `phoneVerificationFailed` listener to be notified when the verification is failed. Use the `phoneCodeSent` listener to get the verification id. | Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | **`options`** | SignInWithPhoneNumberOptions | **Since:** 1.1.0 -------------------- ### linkWithPlayGames(...) ```typescript linkWithPlayGames(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Play Games authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. Only available for Android. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithTwitter(...) ```typescript linkWithTwitter(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Twitter authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### linkWithYahoo(...) ```typescript linkWithYahoo(options?: SignInWithOAuthOptions | undefined) => Promise ``` Links the user account with Yahoo authentication provider. The user must be logged in on the native layer. The `skipNativeAuth` configuration option has no effect here. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### reload() ```typescript reload() => Promise ``` Reloads user account data, if signed in. **Since:** 1.3.0 -------------------- ### revokeAccessToken(...) ```typescript revokeAccessToken(options: RevokeAccessTokenOptions) => Promise ``` Revokes the given access token. Currently only supports Apple OAuth access tokens. | Param | Type | | ------------- | ----------------------------------------------------------------------------- | | **`options`** | RevokeAccessTokenOptions | **Since:** 6.1.0 -------------------- ### sendEmailVerification(...) ```typescript sendEmailVerification(options?: SendEmailVerificationOptions | undefined) => Promise ``` Sends a verification email to the currently signed in user. | Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | **`options`** | SendEmailVerificationOptions | **Since:** 0.2.2 -------------------- ### sendPasswordResetEmail(...) ```typescript sendPasswordResetEmail(options: SendPasswordResetEmailOptions) => Promise ``` Sends a password reset email. | Param | Type | | ------------- | --------------------------------------------------------------------------------------- | | **`options`** | SendPasswordResetEmailOptions | **Since:** 0.2.2 -------------------- ### sendSignInLinkToEmail(...) ```typescript sendSignInLinkToEmail(options: SendSignInLinkToEmailOptions) => Promise ``` Sends a sign-in email link to the user with the specified email. To complete sign in with the email link, call `signInWithEmailLink` with the email address and the email link supplied in the email sent to the user. | Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | **`options`** | SendSignInLinkToEmailOptions | **Since:** 1.1.0 -------------------- ### setLanguageCode(...) ```typescript setLanguageCode(options: SetLanguageCodeOptions) => Promise ``` Sets the user-facing language code for auth operations. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SetLanguageCodeOptions | **Since:** 0.1.0 -------------------- ### setPersistence(...) ```typescript setPersistence(options: SetPersistenceOptions) => Promise ``` Sets the type of persistence for the currently saved auth session. Only available for Web. | Param | Type | | ------------- | ----------------------------------------------------------------------- | | **`options`** | SetPersistenceOptions | **Since:** 5.2.0 -------------------- ### setTenantId(...) ```typescript setTenantId(options: SetTenantIdOptions) => Promise ``` Sets the tenant id. | Param | Type | | ------------- | ----------------------------------------------------------------- | | **`options`** | SetTenantIdOptions | **Since:** 1.1.0 -------------------- ### signInAnonymously() ```typescript signInAnonymously() => Promise ``` Signs in as an anonymous user. **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### signInWithApple(...) ```typescript signInWithApple(options?: SignInWithOAuthOptions | undefined) => Promise ``` Starts the Apple sign-in flow. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithCustomToken(...) ```typescript signInWithCustomToken(options: SignInWithCustomTokenOptions) => Promise ``` Starts the Custom Token sign-in flow. This method cannot be used in combination with `skipNativeAuth` on Android and iOS. In this case you have to use the `signInWithCustomToken` interface of the Firebase JS SDK directly. | Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | **`options`** | SignInWithCustomTokenOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithEmailAndPassword(...) ```typescript signInWithEmailAndPassword(options: SignInWithEmailAndPasswordOptions) => Promise ``` Starts the sign-in flow using an email and password. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------------- | | **`options`** | SignInWithEmailAndPasswordOptions | **Returns:** Promise<SignInResult> **Since:** 0.2.2 -------------------- ### signInWithEmailLink(...) ```typescript signInWithEmailLink(options: SignInWithEmailLinkOptions) => Promise ``` Signs in using an email and sign-in email link. | Param | Type | | ------------- | --------------------------------------------------------------------------------- | | **`options`** | SignInWithEmailLinkOptions | **Returns:** Promise<SignInResult> **Since:** 1.1.0 -------------------- ### signInWithFacebook(...) ```typescript signInWithFacebook(options?: SignInWithFacebookOptions | undefined) => Promise ``` Starts the Facebook sign-in flow. | Param | Type | | ------------- | ------------------------------------------------------------------------------- | | **`options`** | SignInWithFacebookOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithGameCenter(...) ```typescript signInWithGameCenter(options?: SignInWithOAuthOptions | SignInOptions | undefined) => Promise ``` Starts the Game Center sign-in flow. Only available for iOS. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions \| SignInOptions | **Returns:** Promise<SignInResult> **Since:** 1.3.0 -------------------- ### signInWithGithub(...) ```typescript signInWithGithub(options?: SignInWithOAuthOptions | undefined) => Promise ``` Starts the GitHub sign-in flow. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithGoogle(...) ```typescript signInWithGoogle(options?: SignInWithGoogleOptions | undefined) => Promise ``` Starts the Google sign-in flow. | Param | Type | | ------------- | --------------------------------------------------------------------------- | | **`options`** | SignInWithGoogleOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithMicrosoft(...) ```typescript signInWithMicrosoft(options?: SignInWithOAuthOptions | undefined) => Promise ``` Starts the Microsoft sign-in flow. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithOpenIdConnect(...) ```typescript signInWithOpenIdConnect(options: SignInWithOpenIdConnectOptions) => Promise ``` Starts the OpenID Connect sign-in flow. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | **`options`** | SignInWithOpenIdConnectOptions | **Returns:** Promise<SignInResult> **Since:** 6.1.0 -------------------- ### signInWithPhoneNumber(...) ```typescript signInWithPhoneNumber(options: SignInWithPhoneNumberOptions) => Promise ``` Starts the sign-in flow using a phone number. Use the `phoneVerificationCompleted` listener to be notified when the verification is completed. Use the `phoneVerificationFailed` listener to be notified when the verification is failed. Use the `phoneCodeSent` listener to get the verification id. Only available for Android and iOS. | Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | **`options`** | SignInWithPhoneNumberOptions | **Since:** 0.1.0 -------------------- ### signInWithPlayGames(...) ```typescript signInWithPlayGames(options?: SignInWithOAuthOptions | undefined) => Promise ``` Starts the Play Games sign-in flow. Only available for Android. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithTwitter(...) ```typescript signInWithTwitter(options?: SignInWithOAuthOptions | undefined) => Promise ``` Starts the Twitter sign-in flow. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signInWithYahoo(...) ```typescript signInWithYahoo(options?: SignInWithOAuthOptions | undefined) => Promise ``` Starts the Yahoo sign-in flow. | Param | Type | | ------------- | ------------------------------------------------------------------------- | | **`options`** | SignInWithOAuthOptions | **Returns:** Promise<SignInResult> **Since:** 0.1.0 -------------------- ### signOut() ```typescript signOut() => Promise ``` Starts the sign-out flow. **Since:** 0.1.0 -------------------- ### unlink(...) ```typescript unlink(options: UnlinkOptions) => Promise ``` Unlinks a provider from a user account. | Param | Type | | ------------- | ------------------------------------------------------- | | **`options`** | UnlinkOptions | **Returns:** Promise<UnlinkResult> **Since:** 1.1.0 -------------------- ### updateEmail(...) ```typescript updateEmail(options: UpdateEmailOptions) => Promise ``` Updates the email address of the currently signed in user. | Param | Type | | ------------- | ----------------------------------------------------------------- | | **`options`** | UpdateEmailOptions | **Since:** 0.1.0 -------------------- ### updatePassword(...) ```typescript updatePassword(options: UpdatePasswordOptions) => Promise ``` Updates the password of the currently signed in user. | Param | Type | | ------------- | ----------------------------------------------------------------------- | | **`options`** | UpdatePasswordOptions | **Since:** 0.1.0 -------------------- ### updateProfile(...) ```typescript updateProfile(options: UpdateProfileOptions) => Promise ``` Updates a user's profile data. | Param | Type | | ------------- | --------------------------------------------------------------------- | | **`options`** | UpdateProfileOptions | **Since:** 1.3.0 -------------------- ### useAppLanguage() ```typescript useAppLanguage() => Promise ``` Sets the user-facing language code to be the default app language. **Since:** 0.1.0 -------------------- ### useEmulator(...) ```typescript useEmulator(options: UseEmulatorOptions) => Promise ``` Instrument your app to talk to the Authentication emulator. | Param | Type | | ------------- | ----------------------------------------------------------------- | | **`options`** | UseEmulatorOptions | **Since:** 0.2.0 -------------------- ### verifyBeforeUpdateEmail(...) ```typescript verifyBeforeUpdateEmail(options: VerifyBeforeUpdateEmailOptions) => Promise ``` Verifies the new email address before updating the email address of the currently signed in user. | Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | **`options`** | VerifyBeforeUpdateEmailOptions | **Since:** 6.3.0 -------------------- ### checkAppTrackingTransparencyPermission() ```typescript checkAppTrackingTransparencyPermission() => Promise ``` Checks the current status of app tracking transparency. Only available on iOS. **Returns:** Promise<CheckAppTrackingTransparencyPermissionResult> **Since:** 7.2.0 -------------------- ### requestAppTrackingTransparencyPermission() ```typescript requestAppTrackingTransparencyPermission() => Promise ``` Opens the system dialog to authorize app tracking transparency. **Attention:** The user may have disabled the tracking request in the device settings, see [Apple's documentation](https://support.apple.com/guide/iphone/iph4f4cbd242/ios). Only available on iOS. **Returns:** Promise<CheckAppTrackingTransparencyPermissionResult> **Since:** 7.2.0 -------------------- ### addListener('authStateChange', ...) ```typescript addListener(eventName: 'authStateChange', listenerFunc: AuthStateChangeListener) => Promise ``` Listen for the user's sign-in state changes. **Attention:** This listener is not triggered when the `skipNativeAuth` is used. Use the Firebase JavaScript SDK instead. | Param | Type | | ------------------ | --------------------------------------------------------------------------- | | **`eventName`** | 'authStateChange' | | **`listenerFunc`** | AuthStateChangeListener | **Returns:** Promise<PluginListenerHandle> **Since:** 0.1.0 -------------------- ### addListener('idTokenChange', ...) ```typescript addListener(eventName: 'idTokenChange', listenerFunc: IdTokenChangeListener) => Promise ``` Listen to ID token changes for the currently signed-in user. **Attention:** This listener is not triggered when the `skipNativeAuth` is used. Use the Firebase JavaScript SDK instead. | Param | Type | | ------------------ | ----------------------------------------------------------------------- | | **`eventName`** | 'idTokenChange' | | **`listenerFunc`** | IdTokenChangeListener | **Returns:** Promise<PluginListenerHandle> **Since:** 6.3.0 -------------------- ### addListener('phoneVerificationCompleted', ...) ```typescript addListener(eventName: 'phoneVerificationCompleted', listenerFunc: PhoneVerificationCompletedListener) => Promise ``` Listen for a completed phone verification. This listener only fires in two situations: 1. **Instant verification**: In some cases the phone number can be instantly verified without needing to send or enter a verification code. 2. **Auto-retrieval**: On some devices Google Play services can automatically detect the incoming verification SMS and perform verification without user action. Only available for Android. | Param | Type | | ------------------ | ------------------------------------------------------------------------------------------------- | | **`eventName`** | 'phoneVerificationCompleted' | | **`listenerFunc`** | PhoneVerificationCompletedListener | **Returns:** Promise<PluginListenerHandle> **Since:** 1.3.0 -------------------- ### addListener('phoneVerificationFailed', ...) ```typescript addListener(eventName: 'phoneVerificationFailed', listenerFunc: PhoneVerificationFailedListener) => Promise ``` Listen for a failed phone verification. | Param | Type | | ------------------ | ------------------------------------------------------------------------------------------- | | **`eventName`** | 'phoneVerificationFailed' | | **`listenerFunc`** | PhoneVerificationFailedListener | **Returns:** Promise<PluginListenerHandle> **Since:** 1.3.0 -------------------- ### addListener('phoneCodeSent', ...) ```typescript addListener(eventName: 'phoneCodeSent', listenerFunc: PhoneCodeSentListener) => Promise ``` Listen for a phone verification code. | Param | Type | | ------------------ | ----------------------------------------------------------------------- | | **`eventName`** | 'phoneCodeSent' | | **`listenerFunc`** | PhoneCodeSentListener | **Returns:** Promise<PluginListenerHandle> **Since:** 1.3.0 -------------------- ### removeAllListeners() ```typescript removeAllListeners() => Promise ``` Remove all listeners for this plugin. **Since:** 0.1.0 -------------------- ### Interfaces #### ApplyActionCodeOptions | Prop | Type | Description | Since | | ------------- | ------------------- | ------------------------------------- | ----- | | **`oobCode`** | string | A verification code sent to the user. | 0.2.2 | #### ConfirmPasswordResetOptions | Prop | Type | Description | Since | | ----------------- | ------------------- | ------------------------------------- | ----- | | **`oobCode`** | string | A verification code sent to the user. | 0.2.2 | | **`newPassword`** | string | The new password. | 0.2.2 | #### SignInResult | Prop | Type | Description | Since | | ------------------------ | ------------------------------------------------------------------------- | --------------------------------------------------------------- | ----- | | **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 0.1.0 | | **`credential`** | AuthCredential \| null | Credentials returned by an auth provider. | 0.1.0 | | **`additionalUserInfo`** | AdditionalUserInfo \| null | Additional user information from a federated identity provider. | 0.5.1 | #### User | Prop | Type | Description | Since | | ------------------- | ----------------------------------------------------- | -------------------------------------------------------------------- | ----- | | **`displayName`** | string \| null | | 0.1.0 | | **`email`** | string \| null | | 0.1.0 | | **`emailVerified`** | boolean | | 0.1.0 | | **`isAnonymous`** | boolean | | 0.1.0 | | **`metadata`** | UserMetadata | The user's metadata. | 5.2.0 | | **`phoneNumber`** | string \| null | | 0.1.0 | | **`photoUrl`** | string \| null | | 0.1.0 | | **`providerData`** | UserInfo[] | Additional per provider such as displayName and profile information. | 5.2.0 | | **`providerId`** | string | | 0.1.0 | | **`tenantId`** | string \| null | | 0.1.0 | | **`uid`** | string | | 0.1.0 | #### UserMetadata | Prop | Type | Description | Since | | -------------------- | ------------------- | ------------------------------------------------------------- | ----- | | **`creationTime`** | number | Time the user was created in milliseconds since the epoch. | 5.2.0 | | **`lastSignInTime`** | number | Time the user last signed in in milliseconds since the epoch. | 5.2.0 | #### UserInfo | Prop | Type | Description | Since | | ----------------- | --------------------------- | ----------------------------------------------------------------------------------------- | ----- | | **`displayName`** | string \| null | The display name of the user. | 5.2.0 | | **`email`** | string \| null | The email of the user. | 5.2.0 | | **`phoneNumber`** | string \| null | The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. | 5.2.0 | | **`photoUrl`** | string \| null | The profile photo URL of the user. | 5.2.0 | | **`providerId`** | string | The provider used to authenticate the user. | 5.2.0 | | **`uid`** | string | The user's unique ID. | 5.2.0 | #### AuthCredential | Prop | Type | Description | Since | | ----------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **`accessToken`** | string | The OAuth access token associated with the credential if it belongs to an OAuth provider. | 0.1.0 | | **`authorizationCode`** | string | A token that the app uses to interact with the server. Only available for Apple Sign-in on iOS. | 1.2.0 | | **`idToken`** | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider. | 0.1.0 | | **`nonce`** | string | The random string used to make sure that the ID token you get was granted specifically in response to your app's authentication request. | 0.1.0 | | **`providerId`** | string | The authentication provider ID for the credential. | 0.1.0 | | **`secret`** | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider. | 0.1.0 | | **`serverAuthCode`** | string | The server auth code. Only available for Google Sign-in and Play Games Sign-In on Android and iOS. | 5.2.0 | #### AdditionalUserInfo | Prop | Type | Description | Since | | ---------------- | ---------------------------------------- | ----------------------------------------------------------- | ----- | | **`isNewUser`** | boolean | Whether the user is new (sign-up) or existing (sign-in). | 0.5.1 | | **`profile`** | { [key: string]: unknown; } | Map containing IDP-specific user data. | 0.5.1 | | **`providerId`** | string | Identifier for the provider used to authenticate this user. | 0.5.1 | | **`username`** | string | The username if the provider is GitHub or Twitter. | 0.5.1 | #### ConfirmVerificationCodeOptions | Prop | Type | Description | Since | | ---------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **`verificationId`** | string | The verification ID received from the `phoneCodeSent` listener. The `verificationCode` option must also be provided. | 5.0.0 | | **`verificationCode`** | string | The verification code either received from the `phoneCodeSent` listener or entered by the user. The `verificationId` option must also be provided. | 5.0.0 | #### CreateUserWithEmailAndPasswordOptions | Prop | Type | Since | | -------------- | ------------------- | ----- | | **`email`** | string | 0.2.2 | | **`password`** | string | 0.2.2 | #### FetchSignInMethodsForEmailResult | Prop | Type | Description | Since | | ------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **`signInMethods`** | string[] | The sign-in methods for the specified email address. This list is empty when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of authentication methods available for the given email. | 6.0.0 | #### FetchSignInMethodsForEmailOptions | Prop | Type | Description | Since | | ----------- | ------------------- | ------------------------- | ----- | | **`email`** | string | The user's email address. | 6.0.0 | #### GetCurrentUserResult | Prop | Type | Description | Since | | ---------- | --------------------------------------------- | --------------------------------------------------------- | ----- | | **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 0.1.0 | #### GetIdTokenResult | Prop | Type | Description | Since | | ----------- | ------------------- | -------------------------------------- | ----- | | **`token`** | string | The Firebase Auth ID token JWT string. | 0.1.0 | #### GetIdTokenOptions | Prop | Type | Description | Since | | ------------------ | -------------------- | --------------------------------------------- | ----- | | **`forceRefresh`** | boolean | Force refresh regardless of token expiration. | 0.1.0 | #### GetIdTokenResultResult | Prop | Type | Description | Since | | ------------------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | | **`authTime`** | number | The authentication time in milliseconds since the epoch. This is the time the user authenticated (signed in) and not the time the token was refreshed. | 7.4.0 | | **`expirationTime`** | number | The ID token expiration time in milliseconds since the epoch. | 7.4.0 | | **`issuedAtTime`** | number | The ID token issuance time in milliseconds since the epoch. | 7.4.0 | | **`signInProvider`** | string \| null | The sign-in provider through which the ID token was obtained. | 7.4.0 | | **`signInSecondFactor`** | string \| null | The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). | 7.4.0 | | **`claims`** | Record<string, unknown> | The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. | 7.4.0 | #### GetIdTokenResultOptions | Prop | Type | Description | Since | | ------------------ | -------------------- | --------------------------------------------- | ----- | | **`forceRefresh`** | boolean | Force refresh regardless of token expiration. | 7.4.0 | #### GetTenantIdResult | Prop | Type | Description | Since | | -------------- | --------------------------- | ----------------------------------------------- | ----- | | **`tenantId`** | string \| null | The tenant id. `null` if it has never been set. | 1.1.0 | #### IsSignInWithEmailLinkResult | Prop | Type | Description | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------------- | | **`isSignInWithEmailLink`** | boolean | Whether an incoming link is a signup with email link suitable for `signInWithEmailLink(...)`. | #### IsSignInWithEmailLinkOptions | Prop | Type | Description | Since | | --------------- | ------------------- | ------------------------------------------ | ----- | | **`emailLink`** | string | The link sent to the user's email address. | 1.1.0 | #### SignInWithOAuthOptions | Prop | Type | Description | Default | Since | | ---------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----- | | **`customParameters`** | SignInCustomParameter[] | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. Supports Apple, Facebook, GitHub, Google, Microsoft, Twitter and Yahoo on Web. Supports Apple, GitHub, Microsoft, Twitter and Yahoo on Android. Supports GitHub, Microsoft, Twitter and Yahoo on iOS. | | 1.1.0 | | **`mode`** | 'popup' \| 'redirect' | Whether to use the popup-based OAuth authentication flow or the full-page redirect flow. If you choose `redirect`, you will get the result of the call via the `authStateChange` listener after the redirect. Only available for Web. | 'popup' | 1.3.0 | | **`scopes`** | string[] | Scopes to request from provider. Supports Apple, Facebook, GitHub, Google, Microsoft, Twitter and Yahoo on Web. Supports Apple, GitHub, Google, Microsoft, Twitter, Yahoo and Play Games on Android. Supports Facebook, GitHub, Google, Microsoft, Twitter and Yahoo on iOS. | | 1.1.0 | #### SignInCustomParameter | Prop | Type | Description | Since | | ----------- | ------------------- | ------------------------------------------------------------------ | ----- | | **`key`** | string | The custom parameter key (e.g. `login_hint`). | 0.1.0 | | **`value`** | string | The custom parameter value (e.g. `user@firstadd.onmicrosoft.com`). | 0.1.0 | #### LinkWithEmailAndPasswordOptions | Prop | Type | Description | Since | | -------------- | ------------------- | ------------------------- | ----- | | **`email`** | string | The user's email address. | 1.1.0 | | **`password`** | string | The user's password. | 1.1.0 | #### LinkWithEmailLinkOptions | Prop | Type | Description | Since | | --------------- | ------------------- | ------------------------------------------ | ----- | | **`email`** | string | The user's email address. | 1.1.0 | | **`emailLink`** | string | The link sent to the user's email address. | 1.1.0 | #### SignInWithOpenIdConnectOptions | Prop | Type | Description | Since | | ---------------- | ------------------- | ------------------------------- | ----- | | **`providerId`** | string | The OpenID Connect provider ID. | 6.1.0 | #### SignInWithPhoneNumberOptions | Prop | Type | Description | Default | Since | | ----------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | **`phoneNumber`** | string | The phone number to be verified in E.164 format. | | 0.1.0 | | **`recaptchaVerifier`** | unknown | The reCAPTCHA verifier. Must be an instance of `firebase.auth.RecaptchaVerifier`. Only available for Web. | | 5.2.0 | | **`resendCode`** | boolean | Resend the verification code to the specified phone number. `signInWithPhoneNumber` must be called once before using this option. Only available for Android. | false | 1.3.0 | | **`timeout`** | number | The maximum amount of time in seconds to wait for the SMS auto-retrieval. Use 0 to disable SMS-auto-retrieval. Only available for Android. | 60 | 5.4.0 | #### RevokeAccessTokenOptions | Prop | Type | Description | Since | | ----------- | ------------------- | --------------------------- | ----- | | **`token`** | string | The access token to revoke. | 6.1.0 | #### SendEmailVerificationOptions | Prop | Type | Description | Since | | ------------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----- | | **`actionCodeSettings`** | ActionCodeSettings | Structure that contains the required continue/state URL with optional Android and iOS bundle identifiers. | 6.1.0 | #### ActionCodeSettings An interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. | Prop | Type | Description | Since | | --------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **`android`** | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. | | | **`handleCodeInApp`** | boolean | When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. | | | **`iOS`** | { bundleId: string; } | Sets the iOS bundle ID. | | | **`url`** | string | Sets the link continue/state URL. | | | **`linkDomain`** | string | When multiple custom Firebase Hosting link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`). The domain must be configured in Firebase Hosting and owned by the project. | 7.1.0 | #### SendPasswordResetEmailOptions | Prop | Type | Description | Since | | ------------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----- | | **`email`** | string | | 0.2.2 | | **`actionCodeSettings`** | ActionCodeSettings | Structure that contains the required continue/state URL with optional Android and iOS bundle identifiers. | 6.1.0 | #### SendSignInLinkToEmailOptions | Prop | Type | Description | Since | | ------------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----- | | **`email`** | string | The user's email address. | 1.1.0 | | **`actionCodeSettings`** | ActionCodeSettings | Structure that contains the required continue/state URL with optional Android and iOS bundle identifiers. | 1.1.0 | #### SetLanguageCodeOptions | Prop | Type | Description | Since | | ------------------ | ------------------- | --------------------- | ----- | | **`languageCode`** | string | BCP 47 language code. | 0.1.0 | #### SetPersistenceOptions | Prop | Type | Description | Since | | ----------------- | --------------------------------------------------- | ---------------------- | ----- | | **`persistence`** | Persistence | The persistence types. | 5.2.0 | #### SetTenantIdOptions | Prop | Type | Description | Since | | -------------- | ------------------- | -------------- | ----- | | **`tenantId`** | string | The tenant id. | 1.1.0 | #### SignInWithCustomTokenOptions | Prop | Type | Description | Since | | ----------- | ------------------- | --------------------------------- | ----- | | **`token`** | string | The custom token to sign in with. | 0.1.0 | #### SignInWithEmailAndPasswordOptions | Prop | Type | Description | Since | | -------------- | ------------------- | ------------------------- | ----- | | **`email`** | string | The user's email address. | 0.2.2 | | **`password`** | string | The user's password. | 0.2.2 | #### SignInWithEmailLinkOptions | Prop | Type | Description | Since | | --------------- | ------------------- | ------------------------------------------ | ----- | | **`email`** | string | The user's email address. | 1.1.0 | | **`emailLink`** | string | The link sent to the user's email address. | 1.1.0 | #### SignInWithFacebookOptions | Prop | Type | Description | Default | Since | | --------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | **`useLimitedLogin`** | boolean | Whether to use the Facebook Limited Login mode. If set to `true`, no access token will be returned but the user does not have to grant App Tracking Transparency permission. If set to `false`, the user has to grant App Tracking Transparency permission. You can request the permission with `requestAppTrackingTransparencyPermission()`. Only available for iOS. | false | 7.2.0 | #### SignInOptions | Prop | Type | Description | Since | | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | | **`skipNativeAuth`** | boolean | Whether the plugin should skip the native authentication or not. Only needed if you want to use the Firebase JavaScript SDK. This value overwrites the configrations value of the `skipNativeAuth` option. If no value is set, the configuration value is used. **Note that the plugin may behave differently across the platforms.** `skipNativeAuth` cannot be used in combination with `signInWithCustomToken`, `createUserWithEmailAndPassword` or `signInWithEmailAndPassword`. Only available for Android and iOS. | 1.1.0 | #### SignInWithGoogleOptions | Prop | Type | Description | Default | Since | | -------------------------- | -------------------- | --------------------------------------------------------------------------------- | ----------------- | ----- | | **`useCredentialManager`** | boolean | Whether to use the Credential Manager API to sign in. Only available for Android. | true | 7.2.0 | #### UnlinkResult | Prop | Type | Description | Since | | ---------- | --------------------------------------------- | --------------------------------------------------------- | ----- | | **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 1.1.0 | #### UnlinkOptions | Prop | Type | Description | Since | | ---------------- | ------------------------------------------------- | ----------------------- | ----- | | **`providerId`** | ProviderId | The provider to unlink. | 1.1.0 | #### UpdateEmailOptions | Prop | Type | Description | Since | | -------------- | ------------------- | ---------------------- | ----- | | **`newEmail`** | string | The new email address. | 0.2.2 | #### UpdatePasswordOptions | Prop | Type | Description | Since | | ----------------- | ------------------- | ----------------- | ----- | | **`newPassword`** | string | The new password. | 0.2.2 | #### UpdateProfileOptions | Prop | Type | Description | Since | | ----------------- | --------------------------- | ------------------------ | ----- | | **`displayName`** | string \| null | The user's display name. | 1.3.0 | | **`photoUrl`** | string \| null | The user's photo URL. | 1.3.0 | #### UseEmulatorOptions | Prop | Type | Description | Default | Since | | ------------ | ------------------- | --------------------------------------------- | ------------------- | ----- | | **`host`** | string | The emulator host without any port or scheme. | | 0.2.0 | | **`port`** | number | The emulator port. | 9099 | 0.2.0 | | **`scheme`** | string | The emulator scheme. Only available for Web. | "http" | 5.2.0 | #### VerifyBeforeUpdateEmailOptions | Prop | Type | Description | Since | | ------------------------ | ----------------------------------------------------------------- | --------------------------------------------------- | ----- | | **`newEmail`** | string | The new email address to be verified before update. | 6.3.0 | | **`actionCodeSettings`** | ActionCodeSettings | The action code settings | 6.3.0 | #### CheckAppTrackingTransparencyPermissionResult | Prop | Type | Description | Since | | ------------ | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----- | | **`status`** | AppTrackingTransparencyPermissionState | The permission status of App Tracking Transparency. | 7.2.0 | #### PluginListenerHandle | Prop | Type | | ------------ | ----------------------------------------- | | **`remove`** | () => Promise<void> | #### AuthStateChange | Prop | Type | Description | Since | | ---------- | --------------------------------------------- | --------------------------------------------------------- | ----- | | **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 0.1.0 | #### PhoneVerificationCompletedEvent | Prop | Type | Description | Since | | ---------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------- | ----- | | **`verificationCode`** | string | The verification code sent to the user's phone number. If instant verification is used, this property is not set. | 5.0.0 | #### PhoneVerificationFailedEvent | Prop | Type | Description | Since | | ------------- | ------------------- | ------------------ | ----- | | **`message`** | string | The error message. | 1.3.0 | #### PhoneCodeSentEvent | Prop | Type | Description | Since | | -------------------- | ------------------- | ----------------------------------------------------------------------- | ----- | | **`verificationId`** | string | The verification ID, which is needed to identify the verification code. | 1.3.0 | ### Type Aliases #### LinkWithOAuthOptions SignInWithOAuthOptions #### LinkResult SignInResult #### LinkWithOpenIdConnectOptions SignInWithOpenIdConnectOptions #### LinkWithPhoneNumberOptions SignInWithPhoneNumberOptions #### AppTrackingTransparencyPermissionState PermissionState | 'restricted' #### PermissionState 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied' #### RequestAppTrackingTransparencyPermissionResult CheckAppTrackingTransparencyPermissionResult #### AuthStateChangeListener Callback to receive the user's sign-in state change notifications. (change: AuthStateChange): void #### IdTokenChangeListener Callback to receive the ID token change notifications. (change: GetIdTokenResult): void #### PhoneVerificationCompletedListener Callback to receive the verification code sent to the user's phone number. (event: PhoneVerificationCompletedEvent): void #### PhoneVerificationFailedListener Callback to receive notifications of failed phone verification. (event: PhoneVerificationFailedEvent): void #### PhoneCodeSentListener Callback to receive the verification ID. (event: PhoneCodeSentEvent): void ### Enums #### Persistence | Members | Value | Description | Since | | -------------------- | ------------------------------- | -------------------------------------------- | ----- | | **`IndexedDbLocal`** | 'INDEXED_DB_LOCAL' | Long term persistence using IndexedDB. | 5.2.0 | | **`InMemory`** | 'IN_MEMORY' | No persistence. | 5.2.0 | | **`BrowserLocal`** | 'BROWSER_LOCAL' | Long term persistence using local storage. | 5.2.0 | | **`BrowserSession`** | 'BROWSER_SESSION' | Temporary persistence using session storage. | 5.2.0 | #### ProviderId | Members | Value | | ----------------- | ----------------------------------- | | **`APPLE`** | 'apple.com' | | **`FACEBOOK`** | 'facebook.com' | | **`GAME_CENTER`** | 'gc.apple.com' | | **`GITHUB`** | 'github.com' | | **`GOOGLE`** | 'google.com' | | **`MICROSOFT`** | 'microsoft.com' | | **`PLAY_GAMES`** | 'playgames.google.com' | | **`TWITTER`** | 'twitter.com' | | **`YAHOO`** | 'yahoo.com' | | **`PASSWORD`** | 'password' | | **`PHONE`** | 'phone' | ## FAQ ### What does this plugin do? This plugin enables the use of [Firebase Authentication](https://firebase.google.com/docs/auth) in a Capacitor app. It uses the Firebase SDK for [Java](https://firebase.google.com/docs/reference/android) (Android), [Swift](https://firebase.google.com/docs/reference/swift) (iOS) and [JavaScript](https://firebase.google.com/docs/reference/js). ### What is the difference between the web implementation of this plugin and the Firebase JS SDK? The web implementation of this plugin encapsulates the Firebase JS SDK and enables a consistent interface across all platforms. You can decide if you prefer to use the web implementation or the Firebase JS SDK. ### What is the difference between the native and web authentication? For web authentication, the Firebase JS SDK is used. This only works to a limited extent on Android and iOS in the WebViews (see [here](https://developers.googleblog.com/2016/08/modernizing-oauth-interactions-in-native-apps.html)). For native authentication, the native SDKs from Firebase, Google, etc. are used. These offer all the functionalities that the Firebase JS SDK also offers on the web. However, after a login with the native SDK, the user is only logged in on the native layer of the app. If the user should also be logged in on the web layer (for example to access Cloud Firestore via Firebase JS SDK), additional steps are required (see [here](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/firebase-js-sdk.md)). ### How can I use this plugin with the Firebase JavaScript SDK? See [here](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/firebase-js-sdk.md). ### Which sign-in methods are supported? The plugin supports native sign-in with Apple, Facebook, Game Center, GitHub, Google, Microsoft, OpenID Connect, Play Games, Twitter, and Yahoo, as well as anonymous sign-in, email link sign-in, email and password authentication, phone number sign-in, and custom token sign-in. The required setup steps for each sign-in method are linked in the [Installation](#installation) section. ### Can I use this plugin with Ionic, React, Vue or Angular? Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins - [Firebase App Check](https://capawesome.io/docs/sdks/capacitor/firebase/app-check/): Unofficial Capacitor plugin for Firebase App Check. - [Firebase Cloud Firestore](https://capawesome.io/docs/sdks/capacitor/firebase/cloud-firestore/): Unofficial Capacitor plugin for Firebase Cloud Firestore. - [Firebase Cloud Messaging](https://capawesome.io/docs/sdks/capacitor/firebase/cloud-messaging/): Unofficial Capacitor plugin for Firebase Cloud Messaging. ## Newsletter Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/CHANGELOG.md). ## License See [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/LICENSE). ## Credits This plugin is based on the [Capacitor Firebase Authentication](https://github.com/robingenz/capacitor-firebase-authentication) plugin. Thanks to everyone who contributed to the project! [^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.