React Native Firebase
    Preparing search index...

    Module @react-native-firebase/auth

    Functions

    applyActionCode

    Applies an out-of-band email action code (for example from a password reset or email verification link).

    beforeAuthStateChanged

    Registers a callback to run before an auth state change is committed.

    checkActionCode

    Checks the validity of an out-of-band email action code and returns metadata about the pending operation.

    confirmPasswordReset

    Confirms a password reset using the out-of-band code from the reset email.

    connectAuthEmulator

    Connects the Auth instance to the Auth emulator.

    createUserWithEmailAndPassword

    Creates a new user with an email address and password.

    deleteUser

    Deletes the given user account.

    fetchSignInMethodsForEmail

    Fetches the sign-in methods available for the given email address.

    getAdditionalUserInfo

    Returns additional OAuth / federated sign-in information from a UserCredential.

    getAuth

    Returns the Auth instance associated with the provided FirebaseApp.

    getCustomAuthDomain

    Returns the configured custom auth domain for the Auth instance.

    getIdToken

    Returns the current ID token for the user.

    getIdTokenResult

    Returns the decoded ID token result for the user.

    getMultiFactorResolver
    getRedirectResult

    Returns the redirect sign-in result after a browser redirect flow completes.

    initializeAuth

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

    Checks whether an email link is a valid sign-in with email link URL.

    linkWithCredential

    Links the user account with the given credential.

    linkWithPhoneNumber

    Links the user account with a phone number using SMS verification.

    linkWithPopup

    Links the user account with the given provider using a native popup-style flow where supported.

    linkWithRedirect

    Links the user account with the given provider using a redirect-style flow.

    multiFactor

    Returns the multi-factor interface for the given user.

    onAuthStateChanged

    Subscribes to auth state changes for the given Auth instance.

    onIdTokenChanged

    Subscribes to ID token changes for the given Auth instance.

    parseActionCodeURL

    Parses an email action link string.

    reauthenticateWithCredential

    Reauthenticates the user with the given credential.

    reauthenticateWithPhoneNumber

    Reauthenticates the user with a phone number using SMS verification.

    reauthenticateWithPopup

    Reauthenticates the user with the given provider using a native popup-style flow where supported.

    reauthenticateWithRedirect

    Reauthenticates the user with the given provider using a redirect-style flow.

    reload

    Reloads the user's profile data from the server.

    revokeAccessToken

    Revokes the given OAuth access token for the current user.

    revokeToken

    Revokes a user's Sign in with Apple token.

    sendEmailVerification

    Sends an email verification message to the user.

    sendPasswordResetEmail

    Sends a password reset email to the given address.

    sendSignInLinkToEmail

    Sends a sign-in with email link to the given address.

    setLanguageCode

    Sets the Auth language code.

    setPersistence

    Sets the persistence type for the Auth instance.

    signInAnonymously

    Signs in anonymously.

    signInWithCredential

    Signs in with the given auth credential.

    signInWithCustomToken

    Signs in with a custom authentication token.

    signInWithEmailAndPassword

    Signs in with an email address and password.

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

    signInWithPhoneNumber

    Signs in with a phone number and returns a confirmation result for SMS verification.

    signInWithPopup

    Signs in with the given provider using a native popup-style flow where supported.

    signInWithRedirect

    Signs in with the given provider using a redirect-style flow.

    signOut

    Signs out the current user for the given Auth instance.

    Unlinks a provider from the user account.

    updateCurrentUser

    Updates the currently signed-in user on the Auth instance.

    updateEmail

    Updates the user's email address.

    updatePassword

    Updates the user's password.

    updatePhoneNumber

    Updates the user's phone number using a phone auth credential.

    updateProfile

    Updates the user's display name and/or photo URL.

    useDeviceLanguage

    Sets the Auth languageCode from the device locale.

    useUserAccessGroup

    Configures iOS keychain access group sharing for the Auth instance.

    validatePassword

    Validates a password against the project's password policy.

    verifyBeforeUpdateEmail

    Sends a verification email to the new address before updating the user's email.

    verifyPasswordResetCode

    Verifies a password reset code and returns the associated email address.

    verifyPhoneNumber

    Starts native phone number verification and returns a listener for verification events.

    Classes

    ActionCodeURL

    A structure to help parse out the different components involved in an action link URL.

    AppleAuthProvider
    AuthCredential
    EmailAuthCredential
    EmailAuthProvider
    FacebookAuthProvider
    GithubAuthProvider
    GoogleAuthProvider
    OAuthCredential
    OAuthProvider
    OIDCAuthProvider
    PhoneAuthCredential
    PhoneAuthProvider
    PhoneMultiFactorGenerator
    TotpMultiFactorGenerator
    TotpSecret
    TwitterAuthProvider

    Interfaces

    ActionCodeInfo
    ActionCodeSettings
    AdditionalUserInfo
    ApplicationVerifier
    Auth
    AuthError
    AuthErrorMap
    AuthProvider
    AuthSettings
    Config

    Firebase JS SDK auth configuration. Native iOS/Android Firebase Auth SDKs do not expose this object, so Auth.config always returns an empty object on React Native.

    ConfirmationResult
    Dependencies
    EmulatorConfig
    IdTokenResult
    MultiFactorAssertion
    MultiFactorError
    MultiFactorInfo
    MultiFactorResolver
    MultiFactorSession
    MultiFactorUser
    NativeFirebaseAuthError
    OAuthCredentialOptions
    OIDCProvider
    ParsedToken
    PasswordPolicy
    PasswordValidationStatus
    Persistence
    PhoneAuthError
    PhoneAuthListener
    PhoneAuthSnapshot
    PhoneMultiFactorAssertion
    PhoneMultiFactorEnrollInfoOptions
    PhoneMultiFactorInfo
    PhoneMultiFactorSignInInfoOptions
    PhoneSingleFactorInfoOptions
    PopupRedirectResolver
    TotpMultiFactorAssertion
    TotpMultiFactorInfo
    User
    UserCredential
    UserInfo
    UserMetadata

    Namespaces

    FirebaseAuthTypes

    Type Aliases

    AdditionalUserInfoNative

    firebase-js-sdk AdditionalUserInfo fields plus any extra keys returned by the native bridge. Extra keys are preserved for backwards compatibility when native adds provider-specific fields.

    CallbackOrObserver
    CompleteFn
    CustomParameters
    ErrorFn
    NextFn
    NextOrObserver
    PhoneInfoOptions
    Unsubscribe
    UserProfile

    Variables

    ActionCodeOperation
    default
    FactorId
    firebase
    OperationType
    PhoneAuthState
    ProviderId
    SDK_VERSION
    SignInMethod