@capacitor-firebase/authentication

v8.5.2

Published

14 days ago

Capacitor plugin for Firebase Authentication on Android, iOS, and Web.

0High
0Medium
0Low

capacitor plugin native capacitor-plugin firebase firebase auth authentication sign in social login google sign-in apple sign-in phone auth

Capacitor Firebase Authentication Plugin

Unofficial Capacitor plugin for Firebase Authentication.[^1]

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: Setup and best practices for sign-in flows with this plugin.
How to Use Firebase in a Capacitor App: Why sign-in is usually the first Firebase piece to wire up, and what builds on the user ID it produces.

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capawesome Skills to your AI tool using the following command:

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:

npm install @capacitor-firebase/authentication firebase
npx cap sync

Add Firebase to your project if you haven't already (Android / iOS / Web).

On iOS, verify that this function is included in your app's AppDelegate.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:

+ 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:

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.

iOS

Swift Package Manager

Add the following to your capacitor.config.json (or capacitor.config.ts) to avoid a SwiftPM package identity collision:

{
  "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:

{
  "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:

{
  "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:

{
  "plugins": {
    "FirebaseAuthentication": {
      "authDomain": undefined,
      "skipNativeAuth": false,
      "providers": ["apple.com", "facebook.com"]
    }
  }
}

In capacitor.config.ts:

/// <reference types="@capacitor-firebase/authentication" />

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 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

Starter templates

The following starter templates are available:

Ionstarter Angular Firebase

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:

import { FirebaseAuthentication } from '@capacitor-firebase/authentication';

const createUserWithEmailAndPassword = async () => {
  const result = await FirebaseAuthentication.createUserWithEmailAndPassword({
    email: '[email protected]',
    password: '1234',
  });
  return result.user;
};

const signInWithEmailAndPassword = async () => {
  const result = await FirebaseAuthentication.signInWithEmailAndPassword({
    email: '[email protected]',
    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 section. Game Center sign-in is only available on iOS and Play Games sign-in is only available on Android:

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:

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:

import { FirebaseAuthentication } from '@capacitor-firebase/authentication';

const sendSignInLinkToEmail = async () => {
  const email = '[email protected]';
  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

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:

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:

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:

import { FirebaseAuthentication } from '@capacitor-firebase/authentication';

const sendPasswordResetEmail = async () => {
  await FirebaseAuthentication.sendPasswordResetEmail({
    email: '[email protected]',
  });
};

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:

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:

import { FirebaseAuthentication } from '@capacitor-firebase/authentication';

const updateEmail = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  await FirebaseAuthentication.updateEmail({
    newEmail: '[email protected]',
  });
};

const verifyBeforeUpdateEmail = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  await FirebaseAuthentication.verifyBeforeUpdateEmail({
    newEmail: '[email protected]',
    actionCodeSettings: {
      url: 'https://www.example.com/[email protected]&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:

import { FirebaseAuthentication } from '@capacitor-firebase/authentication';

const fetchSignInMethodsForEmail = async () => {
  const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({
    email: '[email protected]',
  });
  return result.signInMethods;
};

Set the language

Set the language code to use, or apply the current app language:

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:

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 instance during development:

import { FirebaseAuthentication } from '@capacitor-firebase/authentication';

const useEmulator = async () => {
  await FirebaseAuthentication.useEmulator({
    host: '10.0.2.2',
    port: 9099,
  });
};

API

applyActionCode(...)

applyActionCode(options: ApplyActionCodeOptions) => Promise<void>

Applies a verification code sent to the user by email.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | ApplyActionCodeOptions |

Since: 0.2.2

confirmPasswordReset(...)

confirmPasswordReset(options: ConfirmPasswordResetOptions) => Promise<void>

Completes the password reset process.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------- | | options | ConfirmPasswordResetOptions |

Since: 0.2.2

confirmVerificationCode(...)

confirmVerificationCode(options: ConfirmVerificationCodeOptions) => Promise<SignInResult>

Finishes the phone number verification process.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | options | ConfirmVerificationCodeOptions |

Returns: Promise<SignInResult>

Since: 5.0.0

createUserWithEmailAndPassword(...)

createUserWithEmailAndPassword(options: CreateUserWithEmailAndPasswordOptions) => Promise<SignInResult>

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()

deleteUser() => Promise<void>

Deletes and signs out the user.

Since: 1.3.0

fetchSignInMethodsForEmail(...)

fetchSignInMethodsForEmail(options: FetchSignInMethodsForEmailOptions) => Promise<FetchSignInMethodsForEmailResult>

Fetches the sign-in methods for an email address.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------------- | | options | FetchSignInMethodsForEmailOptions |

Returns: Promise<FetchSignInMethodsForEmailResult>

Since: 6.0.0

getCurrentUser()

getCurrentUser() => Promise<GetCurrentUserResult>

Fetches the currently signed-in user.

Returns: Promise<GetCurrentUserResult>

Since: 0.1.0

getPendingAuthResult()

getPendingAuthResult() => Promise<SignInResult>

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(...)

getIdToken(options?: GetIdTokenOptions | undefined) => Promise<GetIdTokenResult>

Fetches the Firebase Auth ID Token for the currently signed-in user.

| Param | Type | | ------------- | --------------------------------------------------------------- | | options | GetIdTokenOptions |

Returns: Promise<GetIdTokenResult>

Since: 0.1.0

getIdTokenResult(...)

getIdTokenResult(options?: GetIdTokenResultOptions | undefined) => Promise<GetIdTokenResultResult>

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()

getRedirectResult() => Promise<SignInResult>

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()

getTenantId() => Promise<GetTenantIdResult>

Get the tenant id.

Returns: Promise<GetTenantIdResult>

Since: 1.1.0

isSignInWithEmailLink(...)

isSignInWithEmailLink(options: IsSignInWithEmailLinkOptions) => Promise<IsSignInWithEmailLinkResult>

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(...)

linkWithApple(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithEmailAndPassword(options: LinkWithEmailAndPasswordOptions) => Promise<LinkResult>

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(...)

linkWithEmailLink(options: LinkWithEmailLinkOptions) => Promise<LinkResult>

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(...)

linkWithFacebook(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithGameCenter(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithGithub(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithGoogle(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithMicrosoft(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithOpenIdConnect(options: LinkWithOpenIdConnectOptions) => Promise<LinkResult>

Links the user account with an OpenID Connect provider.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | options | SignInWithOpenIdConnectOptions |

Returns: Promise<SignInResult>

Since: 6.1.0

linkWithPhoneNumber(...)

linkWithPhoneNumber(options: LinkWithPhoneNumberOptions) => Promise<void>

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(...)

linkWithPlayGames(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithTwitter(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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(...)

linkWithYahoo(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>

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()

reload() => Promise<void>

Reloads user account data, if signed in.

Since: 1.3.0

revokeAccessToken(...)

revokeAccessToken(options: RevokeAccessTokenOptions) => Promise<void>

Revokes the given access token. Currently only supports Apple OAuth access tokens.

| Param | Type | | ------------- | ----------------------------------------------------------------------------- | | options | RevokeAccessTokenOptions |

Since: 6.1.0

sendEmailVerification(...)

sendEmailVerification(options?: SendEmailVerificationOptions | undefined) => Promise<void>

Sends a verification email to the currently signed in user.

| Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | options | SendEmailVerificationOptions |

Since: 0.2.2

sendPasswordResetEmail(...)

sendPasswordResetEmail(options: SendPasswordResetEmailOptions) => Promise<void>

Sends a password reset email.

| Param | Type | | ------------- | --------------------------------------------------------------------------------------- | | options | SendPasswordResetEmailOptions |

Since: 0.2.2

sendSignInLinkToEmail(...)

sendSignInLinkToEmail(options: SendSignInLinkToEmailOptions) => Promise<void>

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(...)

setLanguageCode(options: SetLanguageCodeOptions) => Promise<void>

Sets the user-facing language code for auth operations.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SetLanguageCodeOptions |

Since: 0.1.0

setPersistence(...)

setPersistence(options: SetPersistenceOptions) => Promise<void>

Sets the type of persistence for the currently saved auth session.

Only available for Web.

| Param | Type | | ------------- | ----------------------------------------------------------------------- | | options | SetPersistenceOptions |

Since: 5.2.0

setTenantId(...)

setTenantId(options: SetTenantIdOptions) => Promise<void>

Sets the tenant id.

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | SetTenantIdOptions |

Since: 1.1.0

signInAnonymously()

signInAnonymously() => Promise<SignInResult>

Signs in as an anonymous user.

Returns: Promise<SignInResult>

Since: 1.1.0

signInWithApple(...)

signInWithApple(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>

Starts the Apple sign-in flow.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SignInWithOAuthOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithCustomToken(...)

signInWithCustomToken(options: SignInWithCustomTokenOptions) => Promise<SignInResult>

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(...)

signInWithEmailAndPassword(options: SignInWithEmailAndPasswordOptions) => Promise<SignInResult>

Starts the sign-in flow using an email and password.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------------- | | options | SignInWithEmailAndPasswordOptions |

Returns: Promise<SignInResult>

Since: 0.2.2

signInWithEmailLink(...)

signInWithEmailLink(options: SignInWithEmailLinkOptions) => Promise<SignInResult>

Signs in using an email and sign-in email link.

| Param | Type | | ------------- | --------------------------------------------------------------------------------- | | options | SignInWithEmailLinkOptions |

Returns: Promise<SignInResult>

Since: 1.1.0

signInWithFacebook(...)

signInWithFacebook(options?: SignInWithFacebookOptions | undefined) => Promise<SignInResult>

Starts the Facebook sign-in flow.

| Param | Type | | ------------- | ------------------------------------------------------------------------------- | | options | SignInWithFacebookOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithGameCenter(...)

signInWithGameCenter(options?: SignInWithOAuthOptions | SignInOptions | undefined) => Promise<SignInResult>

Starts the Game Center sign-in flow.

Only available for iOS.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------------------------------------- | | options | SignInWithOAuthOptions | SignInOptions |

Returns: Promise<SignInResult>

Since: 1.3.0

signInWithGithub(...)

signInWithGithub(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>

Starts the GitHub sign-in flow.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SignInWithOAuthOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithGoogle(...)

signInWithGoogle(options?: SignInWithGoogleOptions | undefined) => Promise<SignInResult>

Starts the Google sign-in flow.

| Param | Type | | ------------- | --------------------------------------------------------------------------- | | options | SignInWithGoogleOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithMicrosoft(...)

signInWithMicrosoft(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>

Starts the Microsoft sign-in flow.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SignInWithOAuthOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithOpenIdConnect(...)

signInWithOpenIdConnect(options: SignInWithOpenIdConnectOptions) => Promise<SignInResult>

Starts the OpenID Connect sign-in flow.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | options | SignInWithOpenIdConnectOptions |

Returns: Promise<SignInResult>

Since: 6.1.0

signInWithPhoneNumber(...)

signInWithPhoneNumber(options: SignInWithPhoneNumberOptions) => Promise<void>

Starts the sign-in flow using a phone number.

Only available for Android and iOS.

| Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | options | SignInWithPhoneNumberOptions |

Since: 0.1.0

signInWithPlayGames(...)

signInWithPlayGames(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>

Starts the Play Games sign-in flow.

Only available for Android.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SignInWithOAuthOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithTwitter(...)

signInWithTwitter(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>

Starts the Twitter sign-in flow.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SignInWithOAuthOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signInWithYahoo(...)

signInWithYahoo(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>

Starts the Yahoo sign-in flow.

| Param | Type | | ------------- | ------------------------------------------------------------------------- | | options | SignInWithOAuthOptions |

Returns: Promise<SignInResult>

Since: 0.1.0

signOut()

signOut() => Promise<void>

Starts the sign-out flow.

Since: 0.1.0

unlink(...)

unlink(options: UnlinkOptions) => Promise<UnlinkResult>

Unlinks a provider from a user account.

| Param | Type | | ------------- | ------------------------------------------------------- | | options | UnlinkOptions |

Returns: Promise<UnlinkResult>

Since: 1.1.0

updateEmail(...)

updateEmail(options: UpdateEmailOptions) => Promise<void>

Updates the email address of the currently signed in user.

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | UpdateEmailOptions |

Since: 0.1.0

updatePassword(...)

updatePassword(options: UpdatePasswordOptions) => Promise<void>

Updates the password of the currently signed in user.

| Param | Type | | ------------- | ----------------------------------------------------------------------- | | options | UpdatePasswordOptions |

Since: 0.1.0

updateProfile(...)

updateProfile(options: UpdateProfileOptions) => Promise<void>

Updates a user's profile data.

| Param | Type | | ------------- | --------------------------------------------------------------------- | | options | UpdateProfileOptions |

Since: 1.3.0

useAppLanguage()

useAppLanguage() => Promise<void>

Sets the user-facing language code to be the default app language.

Since: 0.1.0

useEmulator(...)

useEmulator(options: UseEmulatorOptions) => Promise<void>

Instrument your app to talk to the Authentication emulator.

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | UseEmulatorOptions |

Since: 0.2.0

verifyBeforeUpdateEmail(...)

verifyBeforeUpdateEmail(options: VerifyBeforeUpdateEmailOptions) => Promise<void>

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()

checkAppTrackingTransparencyPermission() => Promise<CheckAppTrackingTransparencyPermissionResult>

Checks the current status of app tracking transparency.

Only available on iOS.

Returns: Promise<CheckAppTrackingTransparencyPermissionResult>

Since: 7.2.0

requestAppTrackingTransparencyPermission()

requestAppTrackingTransparencyPermission() => Promise<RequestAppTrackingTransparencyPermissionResult>

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.

Only available on iOS.

Returns: Promise<CheckAppTrackingTransparencyPermissionResult>

Since: 7.2.0

addListener('authStateChange', ...)

addListener(eventName: 'authStateChange', listenerFunc: AuthStateChangeListener) => Promise<PluginListenerHandle>

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', ...)

addListener(eventName: 'idTokenChange', listenerFunc: IdTokenChangeListener) => Promise<PluginListenerHandle>

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', ...)

addListener(eventName: 'phoneVerificationCompleted', listenerFunc: PhoneVerificationCompletedListener) => Promise<PluginListenerHandle>

Listen for a completed phone verification.

This listener only fires in two situations:

Instant verification: In some cases the phone number can be instantly verified without needing to send or enter a verification code.
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', ...)

addListener(eventName: 'phoneVerificationFailed', listenerFunc: PhoneVerificationFailedListener) => Promise<PluginListenerHandle>

Listen for a failed phone verification.

| Param | Type | | ------------------ | ------------------------------------------------------------------------------------------- | | eventName | 'phoneVerificationFailed' | | listenerFunc | PhoneVerificationFailedListener |

Returns: Promise<PluginListenerHandle>

Since: 1.3.0

addListener('phoneCodeSent', ...)

addListener(eventName: 'phoneCodeSent', listenerFunc: PhoneCodeSentListener) => Promise<PluginListenerHandle>

Listen for a phone verification code.

| Param | Type | | ------------------ | ----------------------------------------------------------------------- | | eventName | 'phoneCodeSent' | | listenerFunc | PhoneCodeSentListener |

Returns: Promise<PluginListenerHandle>

Since: 1.3.0

removeAllListeners()

removeAllListeners() => Promise<void>

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 |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Capacitor Firebase Authentication Plugin

Use Cases

Compatibility

Guides

Installation

iOS

Swift Package Manager

Package traits

Configuration

Examples

Firebase JavaScript SDK

Demo

Starter templates

Usage

Sign up and sign in with email and password

Sign in with a social provider

Sign in with a phone number

Sign in with an email link

Sign in anonymously

Sign in with a custom token or OpenID Connect

Get the current user and ID token

Send and confirm a password reset

Verify the user's email address

Update the user's email or password

Look up sign-in methods for an email

Set the language

Sign out and delete the user

Use the Firebase Emulator

API

applyActionCode(...)

confirmPasswordReset(...)

confirmVerificationCode(...)

createUserWithEmailAndPassword(...)

deleteUser()

fetchSignInMethodsForEmail(...)

getCurrentUser()

getPendingAuthResult()

getIdToken(...)

getIdTokenResult(...)

getRedirectResult()

getTenantId()

isSignInWithEmailLink(...)

linkWithApple(...)

linkWithEmailAndPassword(...)

linkWithEmailLink(...)

linkWithFacebook(...)

linkWithGameCenter(...)

linkWithGithub(...)

linkWithGoogle(...)

linkWithMicrosoft(...)

linkWithOpenIdConnect(...)

linkWithPhoneNumber(...)

linkWithPlayGames(...)

linkWithTwitter(...)

linkWithYahoo(...)

reload()

revokeAccessToken(...)

sendEmailVerification(...)

sendPasswordResetEmail(...)

sendSignInLinkToEmail(...)

setLanguageCode(...)

setPersistence(...)

setTenantId(...)

signInAnonymously()

signInWithApple(...)

signInWithCustomToken(...)

signInWithEmailAndPassword(...)

signInWithEmailLink(...)

signInWithFacebook(...)

signInWithGameCenter(...)

signInWithGithub(...)

signInWithGoogle(...)

signInWithMicrosoft(...)

signInWithOpenIdConnect(...)