react-native-firebase/docs/api/authentication.md

Authentication

RNFirebase handles authentication for us out of the box, both with email/password-based authentication and through oauth providers (with a separate library to handle oauth providers).

Authentication requires Google Play services to be installed on Android.

Auth

Properties

authenticated: boolean - Returns the current Firebase authentication state.

currentUser: User | null - Returns the currently signed-in user (or null). See the User class documentation for further usage.

Methods

onAuthStateChanged(event: Function): Function

Listen for changes in the users auth state (logging in and out). This method returns a unsubscribe function to stop listening to events. Always ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.

class Example extends React.Component {

  constructor() {
    super();
    this.unsubscribe = null;
  }

  componentDidMount() {
    this.unsubscribe = firebase.auth().onAuthStateChanged((user) => {
      if (user) {
        // User is signed in.
      }
    });
  }

  componentWillUnmount() {
    if (this.unsubscribe) {
      this.unsubscribe();
    }
  }

}

createUserWithEmailAndPassword(email: string, password: string): Promise

We can create a user by calling the createUserWithEmailAndPassword() function. The method accepts two parameters, an email and a password.

firebase.auth().createUserWithEmailAndPassword('foo@bar.com', '123456')
  .then((user) => {
    console.log('user created', user)
  })
  .catch((err) => {
    console.error('An error occurred', err);
  });

signInWithEmailAndPassword(email: string, password: string): Promise

To sign a user in with their email and password, use the signInWithEmailAndPassword() function. It accepts two parameters, the user's email and password:

firebase.auth().signInWithEmailAndPassword('foo@bar.com', '123456')
  .then((user) => {
    console.log('User successfully logged in', user)
  })
  .catch((err) => {
    console.error('User signin error', err);
  });

signInAnonymously(): Promise

Sign an anonymous user. If the user has already signed in, that user will be returned.

firebase.auth().signInAnonymously()
  .then((user) => {
    console.log('Anonymous user successfully logged in', user)
  })
  .catch((err) => {
    console.error('Anonymous user signin error', err);
  });

signInWithCredential(credential: Object): Promise

Sign in the user with a 3rd party credential provider. credential requires the following properties:

{
  provider: string,
  token: string,
  secret: string
}

const credential = {
  provider: 'facebook.com',
  token: '12345',
  secret: '6789',
};

firebase.auth().signInWithCredential(credential)
  .then((user) => {
    console.log('User successfully signed in', user)
  })
  .catch((err) => {
    console.error('User signin error', err);
  });

signInWithCustomToken(token: string): Promise

Sign a user in with a self-signed JWT token.

To sign a user using a self-signed custom token, use the signInWithCustomToken() function. It accepts one parameter, the custom token:

firebase.auth().signInWithCustomToken('12345')
  .then((user) => {
    console.log('User successfully logged in', user)
  })
  .catch((err) => {
    console.error('User signin error', err);
  });

sendPasswordResetEmail(email: string): Promise

Sends a password reset email to the given email address. Unlike the web SDK, the email will contain a password reset link rather than a code.

firebase.auth().sendPasswordResetEmail('foo@bar.com')
  .then(() => {
    console.log('Password reset email sent');
  })
  .catch((error) => {
    console.error('Unable send password reset email', error);
  });

signOut(): Promise

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

firebase.auth().signOut()
  .then(() => {
    console.log('User signed out successfully');
  })
  .catch();

User

User class returned from firebase.auth().currentUser.

### Properties

displayName: string | null - The user's display name (if available).

email: string | null - The user's email address (if available).

emailVerified: boolean - True if the user's email address has been verified.

isAnonymous: boolean

photoURL: string | null - The URL of the user's profile picture (if available).

providerData: Object | null - Additional provider-specific information about the user.

providerId: string | null - The authentication provider ID for the current user. For example, 'facebook.com', or 'google.com'.

uid: string - The user's unique ID.

Methods

delete(): Promise

Delete the current user.

firebase.auth().currentUser
  .delete()
  .then()
  .catch();

getToken(): Promise

Returns the users authentication token.

firebase.auth().currentUser
  .getToken()
  .then((token) => {})
  .catch();

reauthenticate(credential: Object): Promise

Reauthenticate the current user with credentials:

{
  provider: string,
  token: string,
  secret: string
}

const credentials = {
  provider: 'facebook.com',
  token: '12345',
  secret: '6789',
};

firebase.auth().currentUser
  .reauthenticate(credentials)
  .then()
  .catch();

reload(): Promise

Refreshes the current user.

firebase.auth().currentUser
  .reload()
  .then((user) => {})
  .catch();

sendEmailVerification(): Promise

Sends a verification email to a user. This will Promise reject is the user is anonymous.

firebase.auth().currentUser
  .sendEmailVerification()
  .then()
  .catch();

updateEmail(email: string)

Updates the user's email address. See Firebase docs for more information on security & email validation. This will Promise reject is the user is anonymous.

firebase.auth().updateUserEmail('foo@bar.com')
  .then()
  .catch();

updatePassword(password: string)

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate. This will Promise reject is the user is anonymous.

firebase.auth().updatePassword('foobar1234')
  .then()
  .catch();

updateProfile(profile: Object)

Updates a user's profile data. Profile data should be an object of fields to update:

{
  displayName: string,
  photoURL: string,
}

firebase.auth()
  .updateProfile({
    displayName: 'Ari Lerner'
  })
  .then()
  .catch();