Indicates the user represents an anonymous user.

Declaration

@property(nonatomic,readonly,getter=isAnonymous)BOOLanonymous;

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

Declaration

@property(nonatomic,readonly,getter=isEmailVerified)BOOLemailVerified;

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

@property(nonatomic,readonly,nullable)NSString*refreshToken;

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

Declaration

@property(nonatomic,readonly,nonnull)NSArray<id<FIRUserInfo>>*providerData;

Metadata associated with the Firebase user in question.

Declaration

@property(nonatomic,readonly,nonnull)FIRUserMetadata*metadata;

The tenant ID of the current user. nil if none is available.

Declaration

@property(nonatomic,readonly,nullable)NSString*tenantID;

Multi factor object associated with the user. This property is available on iOS only.

Declaration

@property(nonatomic,readonly,nonnull)FIRMultiFactor*multiFactor;

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

Declaration

-(nonnullinstancetype)init;

[Deprecated] Updates the email address for the user. On success, the cached user profiledata is updated. Throws FIRAuthErrorCodeInvalidCredentials error whenEmail EnumerationProtectionis enabled. May fail if there is already an account with this email address that was created using email and password authentication.

Possible error codes:

+`AuthErrorCodeInvalidRecipientEmail`-Indicatesaninvalidrecipientemailwassentintherequest.+`AuthErrorCodeInvalidSender`-Indicatesaninvalidsenderemailissetintheconsoleforthisaction.+`AuthErrorCodeInvalidMessagePayload`-Indicatesaninvalidemailtemplateforsendingupdateemail.+`AuthErrorCodeEmailAlreadyInUse`-Indicatestheemailisalreadyinusebyanotheraccount.+`AuthErrorCodeInvalidEmail`-Indicatestheemailaddressismalformed.+`AuthErrorCodeRequiresRecentLogin`-Updatingauser’semailisasecuritysensitiveoperationthatrequiresarecentloginfromtheuser.Thiserrorindicatestheuserhasnotsignedinrecentlyenough.Toresolve,reauthenticatetheuserbycalling`reauthenticate(with:)`.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)updateEmail:(nonnullNSString*)emailcompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

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

Possible error codes:

+`AuthErrorCodeOperationNotAllowed`-Indicatestheadministratordisabledsigninwiththespecifiedidentityprovider.+`AuthErrorCodeRequiresRecentLogin`-Updatingauser’spasswordisasecuritysensitiveoperationthatrequiresarecentloginfromtheuser.Thiserrorindicatestheuserhasnotsignedinrecentlyenough.Toresolve,reauthenticatetheuserbycalling`reauthenticate(with:)`.+`AuthErrorCodeWeakPassword`-Indicatesanattempttosetapasswordthatisconsideredtooweak.The`NSLocalizedFailureReasonErrorKey`fieldinthe`userInfo`dictionaryobjectwillcontainmoredetailedexplanationthatcanbeshowntotheuser.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)updatePassword:(nonnullNSString*)passwordcompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

Updates the phone number for the user. On success, the cached user profile data is updated. This method is available on iOS only.

Possible error codes:

+`AuthErrorCodeRequiresRecentLogin`-Updatingauser’sphonenumberisasecuritysensitiveoperationthatrequiresarecentloginfromtheuser.Thiserrorindicatestheuserhasnotsignedinrecentlyenough.Toresolve,reauthenticatetheuserbycalling`reauthenticate(with:)`.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)updatePhoneNumberCredential:(nonnullFIRPhoneAuthCredential*)phoneNumberCredentialcompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

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

Set the properties of the returned object, then callUserProfileChangeRequest.commitChanges() to perform the updates atomically.

Declaration

-(nonnullFIRUserProfileChangeRequest*)profileChangeRequest;

Return Value

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

Reloads the user’s profile data from the server.

May fail with aAuthErrorCodeRequiresRecentLogin error code. In this case you should callreauthenticate(with:) before re-invokingupdateEmail(to:).

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

Declaration

-(void)reloadWithCompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

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:

+`AuthErrorCodeInvalidCredential`-Indicatesthesuppliedcredentialisinvalid.Thiscouldhappenifithasexpiredoritismalformed.+`AuthErrorCodeOperationNotAllowed`-Indicatesthataccountswiththeidentityproviderrepresentedbythecredentialarenotenabled.EnablethemintheAuthsectionoftheFirebaseconsole.+`AuthErrorCodeEmailAlreadyInUse`-Indicatestheemailassertedbythecredential(e.g.theemailinaFacebookaccesstoken)isalreadyinusebyanexistingaccount,thatcannotbeauthenticatedwiththismethod.Thiserrorwillonlybethrownifthe"One account per email address"settingisenabledintheFirebaseconsole,underAuthsettings.PleasenotethattheerrorcoderaisedinthisspecificsituationmaynotbethesameonWebandAndroid.+`AuthErrorCodeUserDisabled`-Indicatestheuser'saccountisdisabled.+`AuthErrorCodeWrongPassword`-Indicatestheuserattemptedreauthenticationwithanincorrectpassword,ifcredentialisofthetype`EmailPasswordAuthCredential`.+`AuthErrorCodeUserMismatch`-Indicatesthatanattemptwasmadetoreauthenticatewithauserwhichisnotthecurrentuser.+`AuthErrorCodeInvalidEmail`-Indicatestheemailaddressismalformed.

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

Declaration

-(void)reauthenticateWithCredential:(nonnullFIRAuthCredential*)credentialcompletion:(nullablevoid(^)(FIRAuthDataResult*_Nullable,NSError*_Nullable))completion;

Parameters

Renews the user’s authentication using the provided auth provider instance. This method is available on iOS, macOS Catalyst, and tvOS only.

Declaration

-(void)reauthenticateWithProvider:(nonnullid<FIRFederatedAuthProvider>)providerUIDelegate:(nullableid<FIRAuthUIDelegate>)UIDelegatecompletion:(nullablevoid(^)(FIRAuthDataResult*_Nullable,NSError*_Nullable))completion;

Parameters

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

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

Declaration

-(void)getIDTokenResultWithCompletion:(nullablevoid(^)(FIRAuthTokenResult*_Nullable,NSError*_Nullable))completion;

Parameters

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 ifforceRefresh is YES.

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

Declaration

-(void)getIDTokenResultForcingRefresh:(BOOL)forceRefreshcompletion:(nullablevoid(^)(FIRAuthTokenResult*_Nullable,NSError*_Nullable))completion;

Parameters

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

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

Declaration

-(void)getIDTokenWithCompletion:(nullablevoid(^)(NSString*_Nullable,NSError*_Nullable))completion;

Parameters

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 ifforceRefresh is true.

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

Declaration

-(void)getIDTokenForcingRefresh:(BOOL)forceRefreshcompletion:(nullablevoid(^)(NSString*_Nullable,NSError*_Nullable))completion;

Parameters

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

Possible error codes:

+`AuthErrorCodeProviderAlreadyLinked`-Indicatesanattempttolinkaproviderofatypealreadylinkedtothisaccount.+`AuthErrorCodeCredentialAlreadyInUse`-IndicatesanattempttolinkwithacredentialthathasalreadybeenlinkedwithadifferentFirebaseaccount.+`AuthErrorCodeOperationNotAllowed`-Indicatesthataccountswiththeidentityproviderrepresentedbythecredentialarenotenabled.EnablethemintheAuthsectionoftheFirebaseconsole.

This method may also return error codes associated withupdateEmail(to:) andupdatePassword(to:) onUser.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)linkWithCredential:(nonnullFIRAuthCredential*)credentialcompletion:(nullablevoid(^)(FIRAuthDataResult*_Nullable,NSError*_Nullable))completion;

Parameters

link the user with the provided auth provider instance. This method is available on iOS, macOS Catalyst, and tvOS only.

Declaration

-(void)linkWithProvider:(nonnullid<FIRFederatedAuthProvider>)providerUIDelegate:(nullableid<FIRAuthUIDelegate>)UIDelegatecompletion:(nullablevoid(^)(FIRAuthDataResult*_Nullable,NSError*_Nullable))completion;

Parameters

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

Possible error codes:

+`AuthErrorCodeNoSuchProvider`-Indicatesanattempttounlinkaproviderthatisnotlinkedtotheaccount.+`AuthErrorCodeRequiresRecentLogin`-Updatingemailisasecuritysensitiveoperationthatrequiresarecentloginfromtheuser.Thiserrorindicatestheuserhasnotsignedinrecentlyenough.Toresolve,reauthenticatetheuserbycalling`reauthenticate(with:)`.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)unlinkFromProvider:(nonnullNSString*)providercompletion:(nullablevoid(^)(FIRUser*_Nullable,NSError*_Nullable))completion;

Parameters

Initiates email verification for the user.

Possible error codes:

+`AuthErrorCodeInvalidRecipientEmail`-Indicatesaninvalidrecipientemailwassentintherequest.+`AuthErrorCodeInvalidSender`-Indicatesaninvalidsenderemailissetintheconsoleforthisaction.+`AuthErrorCodeInvalidMessagePayload`-Indicatesaninvalidemailtemplateforsendingupdateemail.+`AuthErrorCodeUserNotFound`-Indicatestheuseraccountwasnotfound.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)sendEmailVerificationWithCompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

Initiates email verification for the user.

Possible error codes:

+`AuthErrorCodeInvalidRecipientEmail`-Indicatesaninvalidrecipientemailwassentintherequest.+`AuthErrorCodeInvalidSender`-Indicatesaninvalidsenderemailissetintheconsoleforthisaction.+`AuthErrorCodeInvalidMessagePayload`-Indicatesaninvalidemailtemplateforsendingupdateemail.+`AuthErrorCodeUserNotFound`-Indicatestheuseraccountwasnotfound.+`AuthErrorCodeMissingIosBundleID`-IndicatesthattheiOSbundleIDismissingwhenaiOSAppStoreIDisprovided.+`AuthErrorCodeMissingAndroidPackageName`-Indicatesthattheandroidpackagenameismissingwhenthe`androidInstallApp`flagissettotrue.+`AuthErrorCodeUnauthorizedDomain`-IndicatesthatthedomainspecifiedinthecontinueURLisnotallowlistedintheFirebaseconsole.+`AuthErrorCodeInvalidContinueURI`-IndicatesthatthedomainspecifiedinthecontinueURLisnotvalid.

Declaration

-(void)sendEmailVerificationWithActionCodeSettings:(nonnullFIRActionCodeSettings*)actionCodeSettingscompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

Deletes the user account (also signs out the user, if this was the current user).

Possible error codes:

+`AuthErrorCodeRequiresRecentLogin`-Updatingemailisasecuritysensitiveoperationthatrequiresarecentloginfromtheuser.Thiserrorindicatestheuserhasnotsignedinrecentlyenough.Toresolve,reauthenticatetheuserbycalling`reauthenticate(with:)`.

SeeAuthErrors for a list of error codes that are common to allUser methods.

Declaration

-(void)deleteWithCompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

Send an email to verify the ownership of the account then update to the new email.

Declaration

-(void)sendEmailVerificationBeforeUpdatingEmail:(nonnullNSString*)emailcompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters

Send an email to verify the ownership of the account then update to the new email.

Declaration

-(void)sendEmailVerificationBeforeUpdatingEmail:(nonnullNSString*)emailactionCodeSettings:(nonnullFIRActionCodeSettings*)actionCodeSettingscompletion:(nullablevoid(^)(NSError*_Nullable))completion;

Parameters