The Firebase Auth service interface.

Do not call this constructor directly. Instead, use firebase.auth().

See Firebase Authentication for a full guide on how to use the Firebase Auth service.

Index

Type aliases

Persistence

Persistence: string

Properties

app

app: App

The app associated with the Auth service instance.

example
var app = auth.app;

currentUser

currentUser: User | null

The currently signed-in user (or null).

languageCode

languageCode: string | null

The current Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified.

settings

settings: AuthSettings

The current Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication.

tenantId

tenantId: string | null

The current Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null.

example
// Set the tenant ID on Auth instance.
firebase.auth().tenantId = ‘TENANT_PROJECT_ID’;

// All future sign-in request now include tenant ID.
firebase.auth().signInWithEmailAndPassword(email, password)
  .then(function(result) {
    // result.user.tenantId should be ‘TENANT_PROJECT_ID’.
  }).catch(function(error) {
    // Handle error.
  });

Variables

Persistence

Persistence: object

An enumeration of the possible persistence mechanism types.

Type declaration

  • LOCAL: Persistence

    Indicates that the state will be persisted even when the browser window is closed or the activity is destroyed in react-native.

  • NONE: Persistence

    Indicates that the state will only be stored in memory and will be cleared when the window or activity is refreshed.

  • SESSION: Persistence

    Indicates that the state will only persist in current session/tab, relevant to web only, and will be cleared when the tab is closed.

Methods

applyActionCode

  • applyActionCode(code: string): Promise<void>
  • Applies a verification code sent to the user by email or other out-of-band mechanism.

    Error Codes

    auth/expired-action-code
    Thrown if the action code has expired.
    auth/invalid-action-code
    Thrown if the action code is invalid. This can happen if the code is malformed or has already been used.
    auth/user-disabled
    Thrown if the user corresponding to the given action code has been disabled.
    auth/user-not-found
    Thrown if there is no user corresponding to the action code. This may have happened if the user was deleted between when the action code was issued and when this method was called.

    Parameters

    • code: string

      A verification code sent to the user.

    Returns Promise<void>

checkActionCode

  • checkActionCode(code: string): Promise<ActionCodeInfo>
  • Checks a verification code sent to the user by email or other out-of-band mechanism.

    Returns metadata about the code.

    Error Codes

    auth/expired-action-code
    Thrown if the action code has expired.
    auth/invalid-action-code
    Thrown if the action code is invalid. This can happen if the code is malformed or has already been used.
    auth/user-disabled
    Thrown if the user corresponding to the given action code has been disabled.
    auth/user-not-found
    Thrown if there is no user corresponding to the action code. This may have happened if the user was deleted between when the action code was issued and when this method was called.

    Parameters

    • code: string

      A verification code sent to the user.

    Returns Promise<ActionCodeInfo>

confirmPasswordReset

  • confirmPasswordReset(code: string, newPassword: string): Promise<void>
  • Completes the password reset process, given a confirmation code and new password.

    Error Codes

    auth/expired-action-code
    Thrown if the password reset code has expired.
    auth/invalid-action-code
    Thrown if the password reset code is invalid. This can happen if the code is malformed or has already been used.
    auth/user-disabled
    Thrown if the user corresponding to the given password reset code has been disabled.
    auth/user-not-found
    Thrown if there is no user corresponding to the password reset code. This may have happened if the user was deleted between when the code was issued and when this method was called.
    auth/weak-password
    Thrown if the new password is not strong enough.

    Parameters

    • code: string

      The confirmation code send via email to the user.

    • newPassword: string

      The new password.

    Returns Promise<void>

createUserWithEmailAndPassword

  • createUserWithEmailAndPassword(email: string, password: string): Promise<UserCredential>
  • Creates a new user account associated with the specified email address and password.

    On successful creation of the user account, this user will also be signed in to your application.

    User account creation can fail if the account already exists or the password is invalid.

    Note: The email address acts as a unique identifier for the user and enables an email-based password reset. This function will create a new user account and set the initial user password.

    Error Codes

    auth/email-already-in-use
    Thrown if there already exists an account with the given email address.
    auth/invalid-email
    Thrown if the email address is not valid.
    auth/operation-not-allowed
    Thrown if email/password accounts are not enabled. Enable email/password accounts in the Firebase Console, under the Auth tab.
    auth/weak-password
    Thrown if the password is not strong enough.
    example
    firebase.auth().createUserWithEmailAndPassword(email, password)
        .catch(function(error) {
      // Handle Errors here.
      var errorCode = error.code;
      var errorMessage = error.message;
      if (errorCode == 'auth/weak-password') {
        alert('The password is too weak.');
      } else {
        alert(errorMessage);
      }
      console.log(error);
    });

    Parameters

    • email: string

      The user's email address.

    • password: string

      The user's chosen password.

    Returns Promise<UserCredential>

fetchSignInMethodsForEmail

  • fetchSignInMethodsForEmail(email: string): Promise<Array<string>>
  • Gets the list of possible sign in methods for the given email address. This is useful to differentiate methods of sign-in for the same provider, eg. EmailAuthProvider which has 2 methods of sign-in, email/password and email/link.

    Error Codes

    auth/invalid-email
    Thrown if the email address is not valid.

    Parameters

    • email: string

    Returns Promise<Array<string>>

isSignInWithEmailLink

  • isSignInWithEmailLink(emailLink: string): boolean
  • Checks if an incoming link is a sign-in with email link.

    Parameters

    • emailLink: string

    Returns boolean

onAuthStateChanged

  • onAuthStateChanged(nextOrObserver: Observer<any> | function, error?: function, completed?: firebase.Unsubscribe): firebase.Unsubscribe
  • Adds an observer for changes to the user's sign-in state.

    Prior to 4.0.0, this triggered the observer when users were signed in, signed out, or when the user's ID token changed in situations such as token expiry or password change. After 4.0.0, the observer is only triggered on sign-in or sign-out.

    To keep the old behavior, see firebase.auth.Auth.onIdTokenChanged.

    example
    firebase.auth().onAuthStateChanged(function(user) {
      if (user) {
        // User is signed in.
      }
    });

    Parameters

    • nextOrObserver: Observer<any> | function
    • Optional error: function
    • Optional completed: firebase.Unsubscribe

    Returns firebase.Unsubscribe

onIdTokenChanged

  • onIdTokenChanged(nextOrObserver: Observer<any> | function, error?: function, completed?: firebase.Unsubscribe): firebase.Unsubscribe
  • Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. This method has the same behavior as firebase.auth.Auth.onAuthStateChanged had prior to 4.0.0.

    example
    firebase.auth().onIdTokenChanged(function(user) {
      if (user) {
        // User is signed in or token was refreshed.
      }
    });

    Parameters

    • nextOrObserver: Observer<any> | function
    • Optional error: function

      Optional A function triggered on auth error.

    • Optional completed: firebase.Unsubscribe

      Optional A function triggered when the observer is removed.

    Returns firebase.Unsubscribe

sendPasswordResetEmail

  • sendPasswordResetEmail(email: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>
  • Sends a password reset email to the given email address.

    To complete the password reset, call firebase.auth.Auth.confirmPasswordReset with the code supplied in the email sent to the user, along with the new password specified by the user.

    Error Codes

    auth/invalid-email
    Thrown if the email address is not valid.
    auth/missing-android-pkg-name
    An Android package name must be provided if the Android app is required to be installed.
    auth/missing-continue-uri
    A continue URL must be provided in the request.
    auth/missing-ios-bundle-id
    An iOS Bundle ID must be provided if an App Store ID is provided.
    auth/invalid-continue-uri
    The continue URL provided in the request is invalid.
    auth/unauthorized-continue-uri
    The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console.
    auth/user-not-found
    Thrown if there is no user corresponding to the email address.
    example
    var actionCodeSettings = {
      url: 'https://www.example.com/?email=user@example.com',
      iOS: {
        bundleId: 'com.example.ios'
      },
      android: {
        packageName: 'com.example.android',
        installApp: true,
        minimumVersion: '12'
      },
      handleCodeInApp: true
    };
    firebase.auth().sendPasswordResetEmail(
        'user@example.com', actionCodeSettings)
        .then(function() {
          // Password reset email sent.
        })
        .catch(function(error) {
          // Error occurred. Inspect error.code.
        });

    Parameters

    • email: string

      The email address with the password to be reset.

    • Optional actionCodeSettings: ActionCodeSettings | null

      The action code settings. If specified, the state/continue URL will be set as the "continueUrl" parameter in the password reset link. The default password reset landing page will use this to display a link to go back to the app if it is installed. If the actionCodeSettings is not specified, no URL is appended to the action URL. The state URL provided must belong to a domain that is whitelisted by the developer in the console. Otherwise an error will be thrown. Mobile app redirects will only be applicable if the developer configures and accepts the Firebase Dynamic Links terms of condition. The Android package name and iOS bundle ID will be respected only if they are configured in the same Firebase Auth project used.

    Returns Promise<void>

sendSignInLinkToEmail

  • sendSignInLinkToEmail(email: string, actionCodeSettings: ActionCodeSettings): Promise<void>
  • Sends a sign-in email link to the user with the specified email.

    The sign-in operation has to always be completed in the app unlike other out of band email actions (password reset and email verifications). This is because, at the end of the flow, the user is expected to be signed in and their Auth state persisted within the app.

    To complete sign in with the email link, call firebase.auth.Auth.signInWithEmailLink with the email address and the email link supplied in the email sent to the user.

    Error Codes

    auth/argument-error
    Thrown if handleCodeInApp is false.
    auth/invalid-email
    Thrown if the email address is not valid.
    auth/missing-android-pkg-name
    An Android package name must be provided if the Android app is required to be installed.
    auth/missing-continue-uri
    A continue URL must be provided in the request.
    auth/missing-ios-bundle-id
    An iOS Bundle ID must be provided if an App Store ID is provided.
    auth/invalid-continue-uri
    The continue URL provided in the request is invalid.
    auth/unauthorized-continue-uri
    The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console.
    example
    var actionCodeSettings = {
      // The URL to redirect to for sign-in completion. This is also the deep
      // link for mobile redirects. The domain (www.example.com) for this URL
      // must be whitelisted in the Firebase Console.
      url: 'https://www.example.com/finishSignUp?cartId=1234',
      iOS: {
        bundleId: 'com.example.ios'
      },
      android: {
        packageName: 'com.example.android',
        installApp: true,
        minimumVersion: '12'
      },
      // This must be true.
      handleCodeInApp: true
    };
    firebase.auth().sendSignInLinkToEmail('user@example.com', actionCodeSettings)
        .then(function() {
          // 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.
        })
        .catch(function(error) {
          // Some error occurred, you can inspect the code: error.code
        });

    Parameters

    • email: string

      The email account to sign in with.

    • actionCodeSettings: ActionCodeSettings

      The action code settings. The action code settings which provides Firebase with instructions on how to construct the email link. This includes the sign in completion URL or the deep link for mobile redirects, the mobile apps to use when the sign-in link is opened on an Android or iOS device. Mobile app redirects will only be applicable if the developer configures and accepts the Firebase Dynamic Links terms of condition. The Android package name and iOS bundle ID will be respected only if they are configured in the same Firebase Auth project used.

    Returns Promise<void>

setPersistence

  • setPersistence(persistence: Persistence): Promise<void>
  • Changes the current type of persistence on the current Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. This will return a promise that will resolve once the state finishes copying from one type of storage to the other. Calling a sign-in method after changing persistence will wait for that persistence change to complete before applying it on the new Auth state.

    This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data.

    The default for web browser apps and React Native apps is 'local' (provided the browser supports this mechanism) whereas it is 'none' for Node.js backend apps.

    Error Codes (thrown synchronously)

    auth/invalid-persistence-type
    Thrown if the specified persistence type is invalid.
    auth/unsupported-persistence-type
    Thrown if the current environment does not support the specified persistence type.
    example
    firebase.auth().setPersistence(firebase.auth.Auth.Persistence.SESSION)
        .then(function() {
      // Existing and future Auth states are now persisted in the current
      // session only. Closing the window would clear any existing state even if
      // a user forgets to sign out.
    });

    Parameters

    Returns Promise<void>

signInAndRetrieveDataWithCredential

  • signInAndRetrieveDataWithCredential(credential: AuthCredential): Promise<UserCredential>
  • deprecated

    This method is deprecated. Use firebase.auth.Auth.signInWithCredential instead.

    Asynchronously signs in with the given credentials, and returns any available additional user information, such as user name.

    Error Codes

    auth/account-exists-with-different-credential
    Thrown if there already exists an account with the email address asserted by the credential. Resolve this by calling firebase.auth.Auth.fetchSignInMethodsForEmail and then asking the user to sign in using one of the returned providers. Once the user is signed in, the original credential can be linked to the user with firebase.User.linkWithCredential.
    auth/invalid-credential
    Thrown if the credential is malformed or has expired.
    auth/operation-not-allowed
    Thrown if the type of account corresponding to the credential is not enabled. Enable the account type in the Firebase Console, under the Auth tab.
    auth/user-disabled
    Thrown if the user corresponding to the given credential has been disabled.
    auth/user-not-found
    Thrown if signing in with a credential from firebase.auth.EmailAuthProvider.credential and there is no user corresponding to the given email.
    auth/wrong-password
    Thrown if signing in with a credential from firebase.auth.EmailAuthProvider.credential and the password is invalid for the given email, or if the account corresponding to the email does not have a password set.
    auth/invalid-verification-code
    Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid.
    auth/invalid-verification-id
    Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.
    example
    firebase.auth().signInAndRetrieveDataWithCredential(credential)
        .then(function(userCredential) {
          console.log(userCredential.additionalUserInfo.username);
        });

    Parameters

    Returns Promise<UserCredential>

signInAnonymously

  • signInAnonymously(): Promise<UserCredential>
  • Asynchronously signs in as an anonymous user.

    If there is already an anonymous user signed in, that user will be returned; otherwise, a new anonymous user identity will be created and returned.

    Error Codes

    auth/operation-not-allowed
    Thrown if anonymous accounts are not enabled. Enable anonymous accounts in the Firebase Console, under the Auth tab.
    example
    firebase.auth().signInAnonymously().catch(function(error) {
      // Handle Errors here.
      var errorCode = error.code;
      var errorMessage = error.message;
    
      if (errorCode === 'auth/operation-not-allowed') {
        alert('You must enable Anonymous auth in the Firebase Console.');
      } else {
        console.error(error);
      }
    });

    Returns Promise<UserCredential>

signInWithCredential