Callable

  • auth ( app ? :  App ) : Auth

  • Gets the Auth service for the default app or a given app.

    firebase.auth() can be called with no arguments to access the default app's Auth service or as firebase.auth(app) to access the Auth service associated with a specific app.

    example
    
// Get the Auth service for the default app
var defaultAuth = firebase.auth();
    example
    
// Get the Auth service for a given app
var otherAuth = firebase.auth(otherApp);

    Parameters

    • Optional app: App

    Returns Auth

Index

Modules

Classes

Interfaces

Type aliases

Type aliases

ActionCodeSettings

ActionCodeSettings: { android?: { installApp?: boolean; minimumVersion?: string; packageName: string }; dynamicLinkDomain?: string; handleCodeInApp?: boolean; iOS?: { bundleId: string }; url: string }

This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. The action code setting fields are:

  • url: Sets the link continue/state URL, which has different meanings in different contexts:

    • When the link is handled in the web action widgets, this is the deep link in the continueUrl query parameter.
    • When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link.
  • iOS: Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed.
  • android: Sets the Android package name. This will try to open the link in an android app if it is installed. If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field. If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app.
  • handleCodeInApp: The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed.

Type declaration

  • Optional android?: { installApp?: boolean; minimumVersion?: string; packageName: string }
    • Optional installApp?: boolean
    • Optional minimumVersion?: string
    • packageName: string
  • Optional dynamicLinkDomain?: string
  • Optional handleCodeInApp?: boolean
  • Optional iOS?: { bundleId: string }
    • bundleId: string
  • url: string

AdditionalUserInfo

AdditionalUserInfo: { isNewUser: boolean; profile: Object | null; providerId: string; username?: string | null }

A structure containing additional user information from a federated identity provider.

Type declaration

  • isNewUser: boolean
  • profile: Object | null
  • providerId: string
  • Optional username?: string | null

PhoneInfoOptions

PhoneInfoOptions: PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions

The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in.

UserCredential

UserCredential: { additionalUserInfo?: AdditionalUserInfo | null; credential: AuthCredential | null; operationType?: string | null; user: User | null }

A structure containing a User, an AuthCredential, the operationType, and any additional user information that was returned from the identity provider. operationType could be 'signIn' for a sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation.

Type declaration