FirebaseAuth Framework Reference


                    
                    
                    auth()

Gets the auth object for the default Firebase app. The default Firebase app must have already been configured or an exception will be raised.

Declaration

Swift

class func auth() -> Auth


                    
                    
                    auth(app:)

Gets the auth object for a FIRApp.

Declaration

Swift

class func auth(app: FIRApp) -> Auth

Parameters

app

The FIRApp for which to retrieve the associated FIRAuth instance.

Return Value

The FIRAuth instance associated with the given FIRApp.

app

Gets the FIRApp object that this auth object is connected to.

Declaration

Swift

weak var app: FIRApp? { get }


                    
                    
                    currentUser

Synchronously gets the cached current user, or null if there is none.

Declaration

Swift

var currentUser: FIRUser? { get }


                    
                    
                    languageCode

The current user language code. This property can be set to the app’s current language by calling useAppLanguage.

The string used to set this property must be a language code that follows BCP 47.

Declaration

Swift

var languageCode: String? { get set }


                    
                    
                    settings

Contains settings related to the auth object.

Declaration

Swift

@NSCopying var settings: FIRAuthSettings? { get set }


                    
                    
                    userAccessGroup

The current user access group that the Auth instance is using. Default is nil.

Declaration

Swift

var userAccessGroup: String? { get }


                    
                    
                    apnsToken

The APNs token used for phone number authentication. The type of the token (production or sandbox) will be attempted to be automatcially detected. If swizzling is disabled, the APNs Token must be set for phone number auth to work, by either setting this property or by calling setAPNSToken:type:

Declaration

Swift

var apnsToken: Data? { get set }


                    
                    
                    -init

Please access auth instances using FIRAuth.auth and FIRAuth.authForApp:.


                    
                    
                    updateCurrentUser(_:completion:)

Sets the currentUser on the calling Auth instance to the provided user object.

Declaration

Swift

func updateCurrentUser(_ user: FIRUser, completion: UserUpdateCallback? = nil)

Parameters

`user`	The user object to be set as the current user of the calling Auth instance.
`completion`	Optionally; a block invoked after the user of the calling Auth instance has been updated or an error was encountered.


                    
                    
                    fetchProviders(forEmail:completion:)

Please use fetchSignInMethodsForEmail:completion: for Objective-C or fetchSignInMethods(forEmail:completion:) for Swift instead.

Declaration

Swift

func fetchProviders(forEmail email: String, completion: ProviderQueryCallback? = nil)


                    
                    
                    fetchSignInMethods(forEmail:completion:)

Fetches the list of all sign-in methods previously used for the provided email address.

Possible error codes:

+ `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.

See FIRAuthErrors for a list of error codes that are common to all API methods.

Declaration

Swift

func fetchSignInMethods(forEmail email: String, completion: SignInMethodQueryCallback? = nil)

Parameters

`email`	The email address for which to obtain a list of sign-in methods.
`completion`	Optionally; a block which is invoked when the list of sign in methods for the specified email address is ready or an error was encountered. Invoked asynchronously on the main thread in the future.


                    
                    
                    signIn(withEmail:password:completion:)

Signs in using an email address and password.

Possible error codes:

+ `FIRAuthErrorCodeOperationNotAllowed` - Indicates that email and password
    accounts are not enabled. Enable them in the Auth section of the
    Firebase console.
+ `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ `FIRAuthErrorCodeWrongPassword` - Indicates the user attempted
    sign in with an incorrect password.
+ `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.

See FIRAuthErrors for a list of error codes that are common to all API methods.

Declaration

Swift

func signIn(withEmail email: String, password: String, completion: AuthDataResultCallback? = nil)

Parameters

`email`	The user’s email address.
`password`	The user’s password.
`completion`	Optionally; a block which is invoked when the sign in flow finishes, or is canceled. Invoked asynchronously on the main thread in the future.


                    
                    
                    signIn(withEmail:link:completion:)

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

Possible error codes:

+ `FIRAuthErrorCodeOperationNotAllowed` - Indicates that email and email sign-in link
    accounts are not enabled. Enable them in the Auth section of the
    Firebase console.
+ `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is invalid.

See FIRAuthErrors for a list of error codes that are common to all API methods.

Declaration

Swift

func signIn(withEmail email: String, link: String, completion: AuthDataResultCallback? = nil)

Parameters

`email`	The user’s email address.
`link`	The email sign-in link.
`completion`	Optionally; a block which is invoked when the sign in flow finishes, or is canceled. Invoked asynchronously on the main thread in the future.


                    
                    
                    -signInWithProvider:UIDelegate:completion:

Signs in using the provided auth provider instance.

Possible error codes:

FIRAuthErrorCodeOperationNotAllowed - Indicates that email and password accounts are not enabled. Enable them in the Auth section of the Firebase console.
FIRAuthErrorCodeUserDisabled - Indicates the user’s account is disabled.
FIRAuthErrorCodeWebNetworkRequestFailed - Indicates that a network request within a SFSafariViewController or UIWebview failed.
FIRAuthErrorCodeWebInternalError - Indicates that an internal error occurred within a SFSafariViewController or UIWebview.
FIRAuthErrorCodeWebSignInUserInteractionFailure - Indicates a general failure during a web sign-in flow.
FIRAuthErrorCodeWebContextAlreadyPresented - Indicates that an attempt was made to present a new web context while one was already being presented.
FIRAuthErrorCodeWebContextCancelled - Indicates that the URL presentation was cancelled prematurely by the user.
FIRAuthErrorCodeAccountExistsWithDifferentCredential - Indicates the email asserted by the credential (e.g. the email in a Facebook access token) is already in use by an existing account, that cannot be authenticated with this sign-in method. Call fetchProvidersForEmail for this user’s email and then prompt them to sign in with any of the sign-in providers returned. This error will only be thrown if the “One account per email address” setting is enabled in the Firebase console, under Auth settings.

See FIRAuthErrors for a list of error codes that are common to all API methods.

Parameters

`provider`	An instance of an auth provider used to initiate the sign-in flow.
`UIDelegate`	Optionally an instance of a class conforming to the FIRAuthUIDelegate protocol, this is used for presenting the web context. If nil, a default FIRAuthUIDelegate will be used.
`completion`	Optionally; a block which is invoked when the sign in flow finishes, or is canceled. Invoked asynchronously on the main thread in the future.


                    
                    
                    signInAndRetrieveData(with:completion:)

Please