Skip to content

Latest commit

 

History

History
316 lines (246 loc) · 11 KB

auth.md

File metadata and controls

316 lines (246 loc) · 11 KB

Authentication Methods

Authentication data is attached to state.firebase.auth, profile is attached to state.firebase.profile if you provide a value to the userProfile config option. You can get them within components like so:

import { connect } from 'react-redux'

const enhance = connect(
  // Map redux state to component props
  ({ firebase: { auth, profile } }) => ({
    auth,
    profile
  })
)

enhance(SomeComponent)

If you need access to methods that are not available at the top level, you can access Firebase's Full Auth API using props.firebase.auth() or getFirebase().auth().

NOTE

All examples below assume you have passed firebase from context to props. Wrapping your component with with the withFirebase or firebaseConnect Higher Order Components will make props.firebase available within your component:

import React from 'react'
import PropTypes from 'prop-types'
import { withFirebase } from 'react-redux-firebase'

const SomeComponent = (props) => (
  // use props.firebase
)

export default withFirebase(SomeComponent) // or firebaseConnect()(SomeComponent)

Works same with class components (make sure you import Component from react):

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { firebaseConnect } from 'react-redux-firebase'

class SomeComponent extends Component {
  render() {
    // use this.props.firebase
  }
}

export default firebaseConnect()(SomeComponent) // or withFirebase(SomeComponent)

login(credentials)

Parameters
  • credentials (Object)
    • Object - cases:
      • email and password (runs ref.authWithPassword(credentials)) : 
        {
  email: String,
  password: String
}
      • provider (runs ref.authWithOAuthPopup(provider) or ref.authWithOAuthRedirect(provider)) : 
        {
  provider: "facebook | google | twitter",
  type: "popup | redirect", // popup is default
  scopes: Array // email is default
}
      • credential (runs ref.signInWithCredential(credential)) : 
        {
  credential: firebase.auth.AuthCredential // created using specific provider
}
        The credential parameter is a firebase.auth.AuthCredential specific to the provider (i.e. firebase.auth.GoogleAuthProvider.credential(null, 'some accessToken')). For more details please view the Firebase API reference
      • provider and token (runs ref.authWithOAuthToken(provider, token)) NOTE: Deprecated as of v1.5.0 : 
        {
  provider: "facebook | google | twitter",
  token : String
}
      • custom token (runs ref.authWithCustomToken(credentials)). profile is required if automatic profile creation is enabled (which it is by default if you are using userProfile). config.updateProfileOnLogin config option can be set to false in order to prevent this behavior. 
        {
  token : String,
  profile: Object // required (optional if updateProfileOnLogin: false config set)
}
      • phone number (runs ref.signInWithPhoneNumber(phoneNumber, applicationVerifier)). Automatic profile creation is enabled by default if you are using the userProfile config option. updateProfileOnLogin config option can be set to false in order to prevent this behavior. 
        {
  phoneNumber: String,
  applicationVerifier: firebase.auth.ApplicationVerifier
}
Returns

Promise that resolves with the response from firebase's login method (an Object). credential property is also included if using oAuth provider.

NOTE: For email authentication in v1.4.* and earlier - The user's UID (a String) is returned instead of an object. This has been changed in v1.5.0 for consistency across all auth types.

Examples

Email

props.firebase.login({
  email: '[email protected]',
  password: 'testest1'
})

OAuth Provider Redirect

props.firebase.login({
  provider: 'google',
  type: 'redirect'
})

OAuth Provider Popup

props.firebase.login({
  provider: 'google',
  type: 'popup',
  // scopes: ['email'] // not required
})

Credential

// `googleUser` from the onsuccess Google Sign In callback
props.firebase.login({
  credential: firebase.auth.GoogleAuthProvider.credential(googleUser.getAuthResponse().id_token)
})
// or using an accessToken
props.firebase.login({
  credential: firebase.auth.GoogleAuthProvider.credential(null, 'some access token')
})

Token

props.firebase.login({
  token: 'someJWTAuthToken',
  profile: { email: '[email protected]' }
})

After logging in, profile and auth are available in redux state:

import { connect } from 'react-redux'

connect((state) => ({
  auth: state.firebase.auth,
  profile: state.firebase.profile
}))(SomeComponent)

For more information on how best to use these methods, visit the auth recipes

createUser(credentials, profile)

Similar to Firebase's ref.createUser(credentials) but with support for automatic profile setup (based on your userProfile config).

NOTE This does not need to be used when using external authentication providers (Firebase creates the user automatically), and is meant to be used with email authentication only.

Parameters

  • credentials Object

    • credentials.email String - User's email
    • credentials.password String - User's password
    • credentials.signIn String - Whether or not to sign in when user is signing up (defaults to true)

  • profile Object

Examples
const createNewUser = ({ email, password, username }) => {
  firebase.createUser(
    { email, password },
    { username, email }
  )
}

// Call with info
createNewUser({
  email: '[email protected]',
  password: 'testest1',
  username: 'tester'
})
Returns

Promise with userData

logout()

Logout from Firebase and delete all data from the store (state.firebase.data and state.firebase.auth are set to null).

Looking to preserve data on logout? v2.0.0 supports the preserve config option, which preserves data under the specified keys in state on logout.

Examples
// logout and remove profile and auth from state
props.firebase.logout()

resetPassword(credentials)

Calls Firebase's firebase.auth().resetPassword(). If there is an error, it is added into redux state under state.firebase.authError.

Examples
props.firebase.resetPassword({
  email: '[email protected]',
  password: 'testest1',
  username: 'tester'
})
Parameters
  • credentials Object - Credentials same as described in firebase docs
  • profile Object - if initialized with userProfile support then profile will be saved into ${userProfile}/${auth.uid}
Returns

Promise with user's UID in case of success or the error otherwise. Always authenticate the new user in case of success

confirmPasswordReset(code, newPassword)

Calls Firebase's firebase.auth().confirmPasswordReset(). If there is an error, it is added into redux state under state.firebase.authError.

Examples
props.firebase.confirmPasswordReset('some reset code', 'myNewPassword')
Parameters
  • code String - Password reset code
  • newPassword String - New password to set for user
Returns

Promise

verifyPasswordResetCode(code)

Verify a password reset code from password reset email.

Calls Firebase's firebase.auth().verifyPasswordResetCode(). If there is an error, it is added into redux state under state.firebase.authError.

Examples
props.firebase.verifyPasswordResetCode('some reset code')
Parameters
  • code String - Password reset code
Returns

Promise - Email associated with reset code

signInWithPhoneNumber(code)

Signs in using a phone number in an async pattern (i.e. requires calling a second method). Calls Firebase's firebase.auth().signInWithPhoneNumber(). If there is an error, it is added into redux state under state.firebase.authError.

From Firebase's docs:

Asynchronously signs in using a phone number. This method sends a code via SMS to the given phone number, and returns a firebase.auth.ConfirmationResult. After the user provides the code sent to their phone, call firebase.auth.ConfirmationResult#confirm with the code to sign the user in.

For more info, check out the following:

Examples
const phoneNumber = "+11234567899" // for US number (123) 456-7899
const recaptchaVerifier = new firebase.auth.RecaptchaVerifier('sign-in-button', {
  'size': 'invisible',
});
firebase.signInWithPhoneNumber(phoneNumber, appVerifier)
    .then((confirmationResult) => {
      // SMS sent. Prompt user to type the code from the message, then sign the
      // user in with confirmationResult.confirm(code).
      const verificationCode = window.prompt('Please enter the verification ' +
          'code that was sent to your mobile device.');
      return confirmationResult.confirm(verificationCode);
    })
    .catch((error) => {
      // Error; SMS not sent
      // Handle Errors Here
      return Promise.reject(error)
    });
Parameters
  • phoneNumber String - The user's phone number in E.164 format (e.g. +16505550101).
  • applicationVerifier firebase.auth.ApplicationVerifier required - App verifier made with Firebase's RecaptchaVerifier
Returns

Promise - Resolves with firebase.auth.ConfirmationResult