FirebaseAuth Framework Reference


                    
                    
                    isAnonymous

Indicates the user represents an anonymous user.

Declaration

Swift

var isAnonymous: Bool { get }


                    
                    
                    isEmailVerified

Indicates the email address associated with this user has been verified.

Declaration

Swift

var isEmailVerified: Bool { get }


                    
                    
                    refreshToken

A refresh token; useful for obtaining new access tokens independently. This property should only be used for advanced scenarios, and is not typically needed.

Declaration

Swift

var refreshToken: String? { get }


                    
                    
                    providerData

Profile data for each identity provider, if any. This data is cached on sign-in and updated when linking or unlinking.

Declaration

Swift

var providerData: [UserInfo] { get }


                    
                    
                    metadata

Metadata associated with the Firebase user in question.

Declaration

Swift

var metadata: FIRUserMetadata { get }


                    
                    
                    -init

This class should not be instantiated. To retrieve the current user, use FIRAuth.currentUser. To sign a user in or out, use the methods on FIRAuth.


                    
                    
                    updateEmail(to:completion:)

Updates the email address for the user. On success, the cached user profile data is updated. May fail if there is already an account with this email address that was created using email and password authentication.

Possible error codes:

+ `FIRAuthErrorCodeInvalidRecipientEmail` - Indicates an invalid recipient email was
    sent in the request.
+ `FIRAuthErrorCodeInvalidSender` - Indicates an invalid sender email is set in
    the console for this action.
+ `FIRAuthErrorCodeInvalidMessagePayload` - Indicates an invalid email template for
    sending update email.
+ `FIRAuthErrorCodeEmailAlreadyInUse` - Indicates the email is already in use by another
    account.
+ `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+ `FIRAuthErrorCodeRequiresRecentLogin` - Updating a user’s email is a security
    sensitive operation that requires a recent login from the user. This error indicates
    the user has not signed in recently enough. To resolve, reauthenticate the user by
    invoking reauthenticateWithCredential:completion: on FIRUser.

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

Declaration

Swift

func updateEmail(to email: String, completion: UserProfileChangeCallback? = nil)

Parameters

`email`	The email address for the user.
`completion`	Optionally; the block invoked when the user profile change has finished. Invoked asynchronously on the main thread in the future.


                    
                    
                    updatePassword(to:completion:)

Updates the password for the user. On success, the cached user profile data is updated.

Possible error codes:

+ `FIRAuthErrorCodeOperationNotAllowed` - Indicates the administrator disabled
    sign in with the specified identity provider.
+ `FIRAuthErrorCodeRequiresRecentLogin` - Updating a user’s password is a security
    sensitive operation that requires a recent login from the user. This error indicates
    the user has not signed in recently enough. To resolve, reauthenticate the user by
    invoking reauthenticateWithCredential:completion: on FIRUser.
+ `FIRAuthErrorCodeWeakPassword` - Indicates an attempt to set a password that is
    considered too weak. The NSLocalizedFailureReasonErrorKey field in the NSError.userInfo
    dictionary object will contain more detailed explanation that can be shown to the user.

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

Declaration

Swift

func updatePassword(to password: String, completion: UserProfileChangeCallback? = nil)

Parameters

`password`	The new password for the user.
`completion`	Optionally; the block invoked when the user profile change has finished. Invoked asynchronously on the main thread in the future.


                    
                    
                    updatePhoneNumber(_:completion:)

Updates the phone number for the user. On success, the cached user profile data is updated.

Possible error codes:

+ `FIRAuthErrorCodeRequiresRecentLogin` - Updating a user’s phone number is a security
    sensitive operation that requires a recent login from the user. This error indicates
    the user has not signed in recently enough. To resolve, reauthenticate the user by
    invoking reauthenticateWithCredential:completion: on FIRUser.

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

Declaration

Swift

func updatePhoneNumber(_ phoneNumberCredential: FIRPhoneAuthCredential, completion: UserProfileChangeCallback? = nil)

Parameters

`phoneNumberCredential`	The new phone number credential corresponding to the phone number to be added to the Firebase account, if a phone number is already linked to the account this new phone number will replace it.
`completion`	Optionally; the block invoked when the user profile change has finished. Invoked asynchronously on the main thread in the future.


                    
                    
                    createProfileChangeRequest()

Creates an object which may be used to change the user’s profile data.

Set the properties of the returned object, then call FIRUserProfileChangeRequest.commitChangesWithCallback: to perform the updates atomically.

Declaration

Swift

func createProfileChangeRequest() -> UserProfileChangeRequest

Return Value

An object which may be used to change the user’s profile data atomically.


                    
                    
                    reload(completion:)

Reloads the user’s profile data from the server.

May fail with a FIRAuthErrorCodeRequiresRecentLogin error code. In this case you should call FIRUser.reauthenticateWithCredential:completion: before re-invoking FIRUser.updateEmail:completion:.

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

Declaration

Swift

func reload(completion: UserProfileChangeCallback? = nil)

Parameters


                                completion

Optionally; the block invoked when the reload has finished. Invoked asynchronously on the main thread in the future.


                    
                    
                    reauthenticate(with:completion:)

Renews the user’s authentication tokens by validating a fresh set of credentials supplied by the user and returns additional identity provider data.

If the user associated with the supplied credential is different from the current user, or if the validation of the supplied credentials fails; an error is returned and the current user remains signed in.

Possible error codes:

+ `FIRAuthErrorCodeInvalidCredential` - Indicates the supplied credential is invalid.
    This could happen if it has expired or it is malformed.
+ `FIRAuthErrorCodeOperationNotAllowed` - Indicates that accounts with the
    identity provider represented by the credential are not enabled. Enable them in the
    Auth section of the Firebase console.
+ `FIRAuthErrorCodeEmailAlreadyInUse` -  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 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. Please note that the
    error code raised in this specific situation may not be the same on Web and Android.
+ `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ `FIRAuthErrorCodeWrongPassword` - Indicates the user attempted reauthentication with
    an incorrect password, if credential is of the type EmailPasswordAuthCredential.
+ `FIRAuthErrorCodeUserMismatch` -  Indicates that an attempt was made to
    reauthenticate with a user which is not the current user.
+ `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 reauthenticate(with credential: FIRAuthCredential, completion: AuthDataResultCallback? = nil)

Parameters

`credential`	A user-supplied credential, which will be validated by the server. This can be a successful third-party identity provider sign-in, or an email address and password.
`completion`	Optionally; the block invoked when the re-authentication operation has finished. Invoked asynchronously on the main thread in the future.


                    
                    
                    reauthenticateAndRetrieveData(with:completion:)

Please use linkWithCredential:completion: for Objective-C or link(withCredential:completion:) for Swift instead.

Declaration

Swift

func reauthenticateAndRetrieveData(with credential: FIRAuthCredential, completion: AuthDataResultCallback? = nil)


                    
                    
                    -reauthenticateWithProvider:UIDelegate:completion:

Renews the user’s authentication using the provided auth provider instance.

Parameters

`provider`	An instance of an auth provider used to initiate the reauthenticate 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 reauthenticate flow finishes, or is canceled. Invoked asynchronously on the main thread in the future.


                    
                    
                    getIDTokenResult(completion:)

Retrieves the Firebase authentication token, possibly refreshing it if it has expired.

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

Declaration

Swift

func getIDTokenResult(completion: AuthTokenResultCallback? = nil)

Parameters


                                completion

Optionally; the block invoked when the token is available. Invoked asynchronously on the main thread in the future.


                    
                    
                    getIDTokenResult(forcingRefresh:completion:)

Retrieves the Firebase authentication token, possibly refreshing it if it has expired.

The authentication token will be refreshed (by making a network request) if it has expired, or if forceRefresh is YES.

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

Declaration

Swift

func getIDTokenResult(forcingRefresh forceRefresh: Bool, completion: AuthTokenResultCallback? = nil)

Parameters

`forceRefresh`	Forces a token refresh. Useful if the token becomes invalid for some reason other than an expiration.
`completion`	Optionally; the block invoked when the token is available. Invoked asynchronously on the main thread in the future.


                    
                    
                    getIDToken(completion:)

Retrieves the Firebase authentication token, possibly refreshing it if it has expired.

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

Declaration

Swift

func getIDToken(completion: AuthTokenCallback? = nil)

Parameters


                                completion

Optionally; the block invoked when the token is available. Invoked asynchronously on the main thread in the future.


                    
                    
                    getIDTokenForcingRefresh(_:completion:)

Retrieves the Firebase authentication token, possibly refreshing it if it has expired.

The authentication token will be refreshed (by making a network request) if it has expired, or if forceRefresh is YES.

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

Declaration

Swift

func getIDTokenForcingRefresh(_ forceRefresh: Bool, completion: AuthTokenCallback? = nil)

Parameters

`forceRefresh`	Forces a token refresh. Useful if the token becomes invalid for some reason other than an expiration.
`completion`	Optionally; the block invoked when the token is available. Invoked asynchronously on the main thread in the future.


                    
                    
                    linkAndRetrieveData(with:completion:)

Please use linkWithCredential:completion: for Objective-C or link(withCredential:completion:) for Swift instead.

Declaration

Swift

func linkAndRetrieveData(with credential: FIRAuthCredential, completion: AuthDataResultCallback? = nil)


                    
                    
                    link(with:completion:)

Associates a user account from a third-party identity provider with this user and returns additional identity provider data.

Possible error codes:

+ `FIRAuthErrorCodeProviderAlreadyLinked` - Indicates an attempt to link a provider of a
    type already linked to this account.
+ `FIRAuthErrorCodeCredentialAlreadyInUse` - Indicates an attempt to link with a
    credential that has already been linked with a different Firebase account.
+ `FIRAuthErrorCodeOperationNotAllowed` - Indicates that accounts with the identity
    provider represented by the credential are not enabled. Enable them in the Auth section
    of the Firebase console.

This method may also return error codes associated with updateEmail:completion: and updatePassword:completion: on FIRUser.

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

Declaration

Swift

func link(with credential: FIRAuthCredential, completion: AuthDataResultCallback? = nil)

Parameters

`credential`	The credential for the identity provider.
`completion`	Optionally; the block invoked when the unlinking is complete, or fails. Invoked asynchronously on the main thread in the future.


                    
                    
                    -linkWithProvider:UIDelegate:completion:

link the user with the provided auth provider instance.

Parameters

`provider`	An instance of an auth provider used to initiate the link 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 link flow finishes, or is canceled. Invoked asynchronously on the main thread in the future.


                    
                    
                    unlink(fromProvider:completion:)

Disassociates a user account from a third-party identity provider with this user.

Possible error codes:

+ `FIRAuthErrorCodeNoSuchProvider` - Indicates an attempt to unlink a provider
    that is not linked to the account.
+ `FIRAuthErrorCodeRequiresRecentLogin` - Updating email is a security sensitive
    operation that requires a recent login from the user. This error indicates the user
    has not signed in recently enough. To resolve, reauthenticate the user by invoking
    reauthenticateWithCredential:completion: on FIRUser.

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

Declaration

Swift

func