firebase:: auth:: User
#include <user.h>
Firebase user account object.
Summary
This class allows you to manipulate the profile of a user, link to and unlink from authentication providers, and refresh authentication tokens.
Inheritance
Inherits from:firebase::auth::UserInfoInterfaceConstructors and Destructors | |
|---|---|
User() | |
User(constUser &)Copy constructor. | |
~User() |
Public functions | |
|---|---|
Delete() | Future< void >Deletes the user account. |
DeleteLastResult() const | Future< void >Get results of the most recent call to Delete. |
GetToken(bool force_refresh) | Future< std::string >The Java Web Token (JWT) that can be used to identify the user to the backend. |
GetTokenLastResult() const | Future< std::string >Get results of the most recent call to GetToken. |
LinkWithCredential(constCredential & credential) | Links the user with the given 3rd party credentials. |
LinkWithCredentialLastResult() const | Get results of the most recent call to LinkWithCredential. |
LinkWithProvider(FederatedAuthProvider *provider) const | |
Reauthenticate(constCredential & credential) | Future< void >Convenience function for ReauthenticateAndRetrieveData that discards the returnedAdditionalUserInfo data. |
ReauthenticateAndRetrieveData(constCredential & credential) | Reauthenticate using a credential. |
ReauthenticateAndRetrieveDataLastResult() const | Get results of the most recent call to ReauthenticateAndRetrieveData. |
ReauthenticateLastResult() const | Future< void >Get results of the most recent call to Reauthenticate. |
ReauthenticateWithProvider(FederatedAuthProvider *provider) const | Re-authenticates the user with a federated auth provider. |
Reload() | Future< void >Refreshes the data for this user. |
ReloadLastResult() const | Future< void >Get results of the most recent call to Reload. |
SendEmailVerification() | Future< void >Initiates email verification for the user. |
SendEmailVerificationBeforeUpdatingEmail(const char *email) | Future< void >Send an email to verify the ownership of the account, then update to the new email. |
SendEmailVerificationBeforeUpdatingEmailLastResult() const | Future< void >Get results of the most recent call to SendEmailVerificationBeforeUpdatingEmail. |
SendEmailVerificationLastResult() const | Future< void >Get results of the most recent call to SendEmailVerification. |
Unlink(const char *provider) | Unlinks the current user from the provider specified. |
UnlinkLastResult() const | Get results of the most recent call to Unlink. |
UpdatePassword(const char *password) | Future< void >Attempts to change the password for the current user. |
UpdatePasswordLastResult() const | Future< void >Get results of the most recent call to UpdatePassword. |
UpdatePhoneNumberCredential(constPhoneAuthCredential & credential) | Updates the currently linked phone number on the user. |
UpdatePhoneNumberCredentialLastResult() const | Get results of the most recent call to UpdatePhoneNumberCredential. |
UpdateUserProfile(constUserProfile & profile) | Future< void >Updates a subset of user profile information. |
UpdateUserProfileLastResult() const | Future< void >Get results of the most recent call to UpdateUserProfile. |
display_name() const | virtual std::stringGets the display name associated with the user, if any. |
email() const | virtual std::stringGets email associated with the user, if any. |
is_anonymous() const | boolReturns true if user signed in anonymously. |
is_email_verified() const | boolReturns true if the email address associated with this user has been verified. |
is_valid() const | boolReturns whether thisUser object represents a valid user. |
metadata() const | Gets the metadata for this user account. |
operator!=(constUser &) const | boolInequality operator. |
operator=(constUser &) | User &Assignment operator. |
operator==(constUser &) const | boolEquality operator. |
phone_number() const | virtual std::stringGets the phone number for the user, in E.164 format. |
photo_url() const | virtual std::stringGets the photo url associated with the user, if any. |
provider_data() const | std::vector<UserInfoInterface >Gets the third party profile data associated with this user returned by the authentication server, if any. |
provider_id() const | virtual std::stringGets the provider ID for the user (For example, "Facebook"). |
uid() const | virtual std::stringGets the unique Firebase user ID for the user. |
Structs | |
|---|---|
| firebase:: | Parameters to theUpdateUserProfile() function. |
Public functions
GetToken
Future<std::string>GetToken(boolforce_refresh)
The Java Web Token (JWT) that can be used to identify the user to the backend.
If a current ID token is still believed to be valid (i.e. it has not yet expired), that token will be returned immediately. A developer may set the optional force_refresh flag to get a new ID token, whether or not the existing token has expired. For example, a developer may use this when they have discovered that the token is invalid for some other reason.
GetTokenLastResult
Future<std::string>GetTokenLastResult()const
Get results of the most recent call to GetToken.
LinkWithCredential
Future<AuthResult>LinkWithCredential(constCredential&credential)
Links the user with the given 3rd party credentials.
For example, a Facebook login access token, a Twitter token/token-secret pair.
Status will be an error if the token is invalid, expired, or otherwise not accepted by the server as well as if the given 3rd party user id is already linked with another user account or if the current user is already linked with another id from the same provider.
Data from the Identity Provider used to sign-in is returned in theAdditionalUserInfo insideAuthResult.
LinkWithCredentialLastResult
Future<AuthResult>LinkWithCredentialLastResult()const
Get results of the most recent call to LinkWithCredential.
LinkWithProvider
Future<AuthResult>LinkWithProvider(FederatedAuthProvider*provider)const
Note: : This operation is supported only on iOS, tvOS and Android platforms. On other platforms this method will return aFuture with a preset error code: kAuthErrorUnimplemented.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns |
Reauthenticate
Future<void>Reauthenticate(constCredential&credential)
Convenience function for ReauthenticateAndRetrieveData that discards the returnedAdditionalUserInfo data.
ReauthenticateAndRetrieveData
Future<AuthResult>ReauthenticateAndRetrieveData(constCredential&credential)
Reauthenticate using a credential.
Some APIs (for example, UpdatePassword, Delete) require that the token used to invoke them be from a recent login attempt. This API takes an existing credential for the user and retrieves fresh tokens, ensuring that the operation can proceed. Developers can call this method prior to callingUpdatePassword() to ensure success.
Data from the Identity Provider used to sign-in is returned in theAdditionalUserInfo inside the returnedAuthResult.
Returns an error if the existing credential is not for this user or if sign-in with that credential failed.
Note: : The current user may be signed out if this operation fails on Android and desktop platforms.
ReauthenticateAndRetrieveDataLastResult
Future<AuthResult>ReauthenticateAndRetrieveDataLastResult()const
Get results of the most recent call to ReauthenticateAndRetrieveData.
ReauthenticateLastResult
Future<void>ReauthenticateLastResult()const
Get results of the most recent call to Reauthenticate.
ReauthenticateWithProvider
Future<AuthResult>ReauthenticateWithProvider(FederatedAuthProvider*provider)const
Re-authenticates the user with a federated auth provider.
Note: : This operation is supported only on iOS, tvOS and Android platforms. On other platforms this method will return aFuture with a preset error code: kAuthErrorUnimplemented.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns |
Reload
Future<void>Reload()
Refreshes the data for this user.
For example, the attached providers, email address, display name, etc.
SendEmailVerificationBeforeUpdatingEmail
Future<void>SendEmailVerificationBeforeUpdatingEmail(constchar*email)
Send an email to verify the ownership of the account, then update to the new email.
SendEmailVerificationBeforeUpdatingEmailLastResult
Future<void>SendEmailVerificationBeforeUpdatingEmailLastResult()const
Get results of the most recent call to SendEmailVerificationBeforeUpdatingEmail.
SendEmailVerificationLastResult
Future<void>SendEmailVerificationLastResult()const
Get results of the most recent call to SendEmailVerification.
Unlink
Future<AuthResult>Unlink(constchar*provider)
Unlinks the current user from the provider specified.
Status will be an error if the user is not linked to the given provider.
UnlinkLastResult
Future<AuthResult>UnlinkLastResult()const
Get results of the most recent call to Unlink.
UpdatePassword
Future<void>UpdatePassword(constchar*password)
Attempts to change the password for the current user.
For an account linked to an Identity Provider (IDP) with no password, this will result in the account becoming an email/password-based account while maintaining the IDP link. May fail if the password is invalid, if there is a conflicting email/password-based account, or if the token has expired. To retrieve fresh tokens, call Reauthenticate.
UpdatePasswordLastResult
Future<void>UpdatePasswordLastResult()const
Get results of the most recent call to UpdatePassword.
UpdatePhoneNumberCredential
Future<User>UpdatePhoneNumberCredential(constPhoneAuthCredential&credential)
Updates the currently linked phone number on the user.
This is useful when a user wants to change their phone number. It is a shortcut to calling Unlink(phone_credential.provider().c_str()) and then LinkWithCredential(phone_credential).credential must have been created withPhoneAuthProvider.
UpdatePhoneNumberCredentialLastResult
Future<User>UpdatePhoneNumberCredentialLastResult()const
Get results of the most recent call to UpdatePhoneNumberCredential.
UpdateUserProfile
Future<void>UpdateUserProfile(constUserProfile&profile)
Updates a subset of user profile information.
UpdateUserProfileLastResult
Future<void>UpdateUserProfileLastResult()const
Get results of the most recent call to UpdateUserProfile.
User
User()
display_name
virtualstd::stringdisplay_name()const
Gets the display name associated with the user, if any.
virtualstd::stringemail()const
Gets email associated with the user, if any.
is_anonymous
boolis_anonymous()const
Returns true if user signed in anonymously.
is_email_verified
boolis_email_verified()const
Returns true if the email address associated with this user has been verified.
is_valid
boolis_valid()const
Returns whether thisUser object represents a valid user.
Could be false on Users contained withAuthResult structures from failedAuth operations.
phone_number
virtualstd::stringphone_number()const
Gets the phone number for the user, in E.164 format.
photo_url
virtualstd::stringphoto_url()const
Gets the photo url associated with the user, if any.
provider_data
std::vector<UserInfoInterface>provider_data()const
Gets the third party profile data associated with this user returned by the authentication server, if any.
provider_id
virtualstd::stringprovider_id()const
Gets the provider ID for the user (For example, "Facebook").
uid
virtualstd::stringuid()const
Gets the unique Firebase user ID for the user.
Note: The user's ID, unique to the Firebase project. Do NOT use this value to authenticate with your backend server, if you have one. UseUser::GetToken() instead.
~User
~User()
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-23 UTC.