[ Web Proxy ]
URL:
Viewing: https://firebase.google.com/docs/reference/node/firebase.auth.PhoneAuthProvider [Back]  [Original]
PhoneAuthProvider | JavaScript SDK  |  Node.js (client) API reference  |  Firebase Skip to main content
Firebase [Firebase]
Build Run Solutions Pricing Docs Support
Search:
Blog Go to console
Overview Fundamentals AI Build Run Reference Samples
Firebase [Firebase]
Send feedback Stay organized with collections Save and categorize content based on your preferences.

Phone number auth provider.

example
// 'recaptcha-container' is the ID of an element in the DOM.
var applicationVerifier = new firebase.auth.RecaptchaVerifier(
    'recaptcha-container');
var provider = new firebase.auth.PhoneAuthProvider();
provider.verifyPhoneNumber('+16505550101', applicationVerifier)
    .then(function(verificationId) {
      var verificationCode = window.prompt('Please enter the verification ' +
          'code that was sent to your mobile device.');
      return firebase.auth.PhoneAuthProvider.credential(verificationId,
          verificationCode);
    })
    .then(function(phoneCredential) {
      return firebase.auth().signInWithCredential(phoneCredential);
    });
param

The Firebase Auth instance in which sign-ins should occur. Uses the default Auth instance if unspecified.

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

providerId

providerId: string

Implementation of AuthProvider.providerId

Inherited from PhoneAuthProvider.providerId

Static PHONE_SIGN_IN_METHOD

PHONE_SIGN_IN_METHOD: string

This corresponds to the sign-in method identifier as returned in firebase.auth.Auth.fetchSignInMethodsForEmail.

Static PROVIDER_ID

PROVIDER_ID: string

Methods

verifyPhoneNumber

  • verifyPhoneNumber ( phoneInfoOptions :  PhoneInfoOptions | string ,  applicationVerifier :  ApplicationVerifier ) : Promise < string >

  • Inherited from PhoneAuthProvider.verifyPhoneNumber

    Starts a phone number authentication flow by sending a verification code to the given phone number. Returns an ID that can be passed to firebase.auth.PhoneAuthProvider.credential to identify this flow.

    For abuse prevention, this method also requires a firebase.auth.ApplicationVerifier. The Firebase Auth SDK includes a reCAPTCHA-based implementation, firebase.auth.RecaptchaVerifier.

    Error Codes

    auth/captcha-check-failed
    Thrown if the reCAPTCHA response token was invalid, expired, or if this method was called from a non-whitelisted domain.
    auth/invalid-phone-number
    Thrown if the phone number has an invalid format.
    auth/missing-phone-number
    Thrown if the phone number is missing.
    auth/quota-exceeded
    Thrown if the SMS quota for the Firebase project has been exceeded.
    auth/user-disabled
    Thrown if the user corresponding to the given phone number has been disabled.
    auth/maximum-second-factor-count-exceeded
    Thrown if The maximum allowed number of second factors on a user has been exceeded.
    auth/second-factor-already-in-use
    Thrown if the second factor is already enrolled on this account.
    auth/unsupported-first-factor
    Thrown if the first factor being used to sign in is not supported.
    auth/unverified-email
    Thrown if the email of the account is not verified.

    Parameters

    Returns Promise<string>

    A Promise for the verification ID.

Static credential

  • credential ( verificationId :  string ,  verificationCode :  string ) : AuthCredential

  • Creates a phone auth credential, given the verification ID from firebase.auth.PhoneAuthProvider.verifyPhoneNumber and the code that was sent to the user's mobile device.

    Error Codes

    auth/missing-verification-code
    Thrown if the verification code is missing.
    auth/missing-verification-id
    Thrown if the verification ID is missing.

    Parameters

    Returns AuthCredential

    The auth provider credential.

Send feedback

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-27 UTC.

Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-07-27 UTC."],[],[]]
Web Proxy Viewer  |  New URL  |  Original Page