React Native Firebase
    Preparing search index...

    Module @react-native-firebase/auth

    Functions

    applyActionCode

    Applies a verification code sent to the user by email or other out-of-band mechanism.

    beforeAuthStateChanged

    Adds a blocking callback that runs before an auth state change sets a new user.

    checkActionCode

    Checks a verification code sent to the user by email or other out-of-band mechanism.

    confirmPasswordReset

    Completes the password reset process, given a confirmation code and new password.

    connectAuthEmulator

    Changes the Auth instance to communicate with the Firebase Auth Emulator, instead of production Firebase Auth services.

    createUserWithEmailAndPassword

    Creates a new user account associated with the specified email address and password.

    deleteUser

    Deletes and signs out the user.

    fetchSignInMethodsForEmail

    Gets the list of possible sign in methods for the given email address.

    getAdditionalUserInfo

    Extracts provider specific AdditionalUserInfo for the given credential.

    getAuth

    Returns the Auth instance associated with the provided FirebaseApp.

    getCustomAuthDomain

    Returns the custom auth domain for the auth instance.

    getIdToken

    Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.

    getIdTokenResult

    Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.

    getMultiFactorResolver

    Provides a MultiFactorResolver suitable for completion of a multi-factor flow.

    getRedirectResult

    Returns a UserCredential from the redirect-based sign-in flow.

    initializeAuth

    This function allows more control over the Auth instance than getAuth().

    initializeRecaptchaConfig

    Loads the reCAPTCHA configuration into the Auth instance. Does not work in a Node.js environment

    Checks if an incoming link is a sign-in with email link suitable for signInWithEmailLink. Note that android and other platforms require apiKey link parameter for signInWithEmailLink

    linkWithCredential

    Links the user account with the given credentials.

    linkWithPhoneNumber

    Links the user account with the given phone number.

    linkWithPopup

    Links the authenticated provider to the user account using a pop-up based OAuth flow.

    linkWithRedirect

    Links the OAuthProvider to the user account using a full-page redirect flow.

    multiFactor

    The MultiFactorUser corresponding to the user.

    onAuthStateChanged

    Adds an observer for changes to the user's sign-in state.

    onIdTokenChanged

    Adds an observer for changes to the signed-in user's ID token.

    parseActionCodeURL

    Parses the email action link string and returns an ActionCodeURL if the link is valid, otherwise returns null.

    reauthenticateWithCredential

    Re-authenticates a user using a fresh credential.

    reauthenticateWithPhoneNumber

    Re-authenticates a user using a fresh phone credential.

    reauthenticateWithPopup

    Re-authenticate a user with a federated authentication provider (Microsoft, Yahoo). For native platforms, this will open a browser window.

    reauthenticateWithRedirect

    Re-authenticate a user with a federated authentication provider (Microsoft, Yahoo). For native platforms, this will open a browser window.

    reload

    Reloads user account data, if signed in.

    revokeAccessToken

    Revoke the given access token, Currently only supports Apple OAuth access tokens.

    sendEmailVerification

    Sends a verification email to a user.

    sendPasswordResetEmail

    Sends a password reset email to the given email address.

    sendSignInLinkToEmail

    Sends a sign-in email link to the user with the specified email.

    setLanguageCode

    Sets the language code.

    setPersistence

    Changes the type of persistence on the 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.

    signInAnonymously

    Asynchronously signs in as an anonymous user.

    signInWithCredential

    Asynchronously signs in with the given credentials.

    signInWithCustomToken

    Asynchronously signs in using a custom token.

    signInWithEmailAndPassword

    Asynchronously signs in using an email and password.

    Asynchronously signs in using an email and sign-in email link.

    signInWithPhoneNumber

    Asynchronously signs in using a phone number.

    signInWithPopup

    Authenticates a Firebase client using a popup-based OAuth authentication flow.

    signInWithRedirect

    Authenticates a Firebase client using a full-page redirect flow.

    signOut

    Signs out the current user.

    Unlinks a provider from a user account.

    updateCurrentUser

    Asynchronously sets the provided user as Auth.currentUser on the Auth instance.

    updateEmail

    Updates the user's email address.

    updatePassword

    Updates the user's password.

    updatePhoneNumber

    Updates the user's phone number.

    updateProfile

    Updates a user's profile data.

    useDeviceLanguage

    Sets the current language to the default device/browser preference.

    useUserAccessGroup

    Configures a shared user access group to sync auth state across multiple apps via the Keychain.

    validatePassword

    Validates the password against the password policy configured for the project or tenant.

    verifyBeforeUpdateEmail

    Sends a verification email to a new email address.

    verifyPasswordResetCode

    Verifies the password reset code sent to the user by email or other out-of-band mechanism.

    verifyPhoneNumber

    Asynchronously signs in using a phone number.

    Interfaces

    ApplicationVerifier

    Interface representing an application verifier.

    PasswordValidationStatus

    A structure indicating which password policy requirements were met or violated and what the requirements are.

    PopupRedirectResolver

    Namespaces

    FirebaseAuthTypes

    Firebase Authentication package for React Native.

    References

    EmailAuthProvider → AppleAuthProvider
    FacebookAuthProvider → AppleAuthProvider
    GithubAuthProvider → AppleAuthProvider
    GoogleAuthProvider → AppleAuthProvider
    OAuthProvider → AppleAuthProvider
    OIDCAuthProvider → AppleAuthProvider
    PhoneAuthProvider → AppleAuthProvider
    PhoneAuthState → AppleAuthProvider
    PhoneMultiFactorGenerator → AppleAuthProvider
    TotpMultiFactorGenerator → AppleAuthProvider
    TotpSecret → AppleAuthProvider
    TwitterAuthProvider → AppleAuthProvider

    Type Aliases

    CallbackOrObserver
    Persistence

    Type of Persistence.

    • 'SESSION' is used for temporary persistence such as sessionStorage.
    • 'LOCAL' is used for long term persistence such as localStorage or IndexedDB.
    • 'NONE' is used for in-memory, or no persistence.

    Variables

    AppleAuthProvider
    default
    firebase