Interface User

Represents a user's profile information in your Firebase project's user database. It also contains helper methods to change or retrieve profile information, as well as to manage that user's authentication state.

Example 1

Subscribing to the users authentication state.

firebase.auth().onAuthStateChanged((user) => {
  if (user) {
    console.log('User email: ', user.email);
  }
});

Example 2

const user = firebase.auth().currentUser;

if (user) {
 console.log('User email: ', user.email);
}

interface User {
    displayName: string | null;
    email: string | null;
    emailVerified: boolean;
    isAnonymous: boolean;
    metadata: UserMetadata;
    multiFactor: MultiFactor | null;
    phoneNumber: string | null;
    photoURL: string | null;
    providerData: UserInfo[];
    providerId: string;
    uid: string;
    delete(): Promise<void>;
    getIdToken(forceRefresh?: boolean): Promise<string>;
    getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
    linkWithCredential(credential: AuthCredential): Promise<UserCredential>;
    linkWithPopup(provider: AuthProvider): Promise<UserCredential>;
    linkWithRedirect(provider: AuthProvider): Promise<UserCredential>;
    reauthenticateWithCredential(
        credential: AuthCredential,
    ): Promise<UserCredential>;
    reauthenticateWithPopup(provider: AuthProvider): Promise<UserCredential>;
    reauthenticateWithRedirect(provider: AuthProvider): Promise<void>;
    reload(): Promise<void>;
    sendEmailVerification(
        actionCodeSettings?: ActionCodeSettings,
    ): Promise<void>;
    toJSON(): object;
    unlink(providerId: string): Promise<User>;
    updateEmail(email: string): Promise<void>;
    updatePassword(password: string): Promise<void>;
    updatePhoneNumber(credential: AuthCredential): Promise<void>;
    updateProfile(updates: UpdateProfile): Promise<void>;
    verifyBeforeUpdateEmail(
        email: string,
        actionCodeSettings?: ActionCodeSettings,
    ): Promise<void>;
}

Methods

delete

delete(): Promise<void>
Delete the current user.

Example
```
await firebase.auth().currentUser.delete();
```
Returns Promise<void>
Error
auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold. Use auth.User#reauthenticateWithCredential to resolve. This does not apply if the user is anonymous.
- Defined in auth/lib/index.d.ts:1309

getIdToken

getIdToken(forceRefresh?: boolean): Promise<string>
Returns the users authentication token.

Example
```
// Force a token refresh
const idToken = await firebase.auth().currentUser.getIdToken(true);
```
Parameters
- OptionalforceRefresh: boolean
  A boolean value which forces Firebase to refresh the token.
Returns Promise<string>
- Defined in auth/lib/index.d.ts:1323

getIdTokenResult

getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>
Returns a firebase.auth.IdTokenResult object which contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.

Example
```
// Force a token refresh
const idTokenResult = await firebase.auth().currentUser.getIdTokenResult(true);
```
Parameters
- OptionalforceRefresh: boolean
  boolean Force refresh regardless of token expiration.
Returns Promise<IdTokenResult>
- Defined in auth/lib/index.d.ts:1339

linkWithCredential

linkWithCredential(credential: AuthCredential): Promise<UserCredential>
Link the user with a 3rd party credential provider.

Example
```
const facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');
const userCredential = await firebase.auth().currentUser.linkWithCredential(facebookCredential);
```
Parameters
- credential: AuthCredential
  A created AuthCredential.
Returns Promise<UserCredential>
Error
auth/provider-already-linked Thrown if the provider has already been linked to the user. This error is thrown even if this is not the same provider's account that is currently linked to the user.

Error
auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method.

Error
auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User.

Error
auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users.

Error
auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider.

Error
auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid.

Error
auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password.

Error
auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid.

Error
auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

Throws
on iOS NativeFirebaseAuthError, on Android NativeFirebaseError
- Defined in auth/lib/index.d.ts:1363

linkWithPopup

linkWithPopup(provider: AuthProvider): Promise<UserCredential>
Link the user with a federated 3rd party credential provider (Microsoft, Yahoo). The APIs here are the web-compatible linkWithPopup and linkWithRedirect but both share the same underlying native SDK behavior and may be used interchangably.

Example
```
const provider = new firebase.auth.OAuthProvider('microsoft.com');
const userCredential = await firebase.auth().currentUser.linkWithPopup(provider);
```
Parameters
- provider: AuthProvider
  A created AuthProvider.
Returns Promise<UserCredential>
Error
auth/provider-already-linked Thrown if the provider has already been linked to the user. This error is thrown even if this is not the same provider's account that is currently linked to the user.

Error
auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method.

Error
auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User.

Error
auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users.

Error
auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider.

Error
auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid.

Error
auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password.

Error
auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid.

Error
auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

Throws
on iOS NativeFirebaseAuthError, on Android NativeFirebaseError
- Defined in auth/lib/index.d.ts:1389

linkWithRedirect

linkWithRedirect(provider: AuthProvider): Promise<UserCredential>
Link the user with a federated 3rd party credential provider (Microsoft, Yahoo). The APIs here are the web-compatible linkWithPopup and linkWithRedirect but both share the same underlying native SDK behavior and may be used interchangably.

Example
```
const provider = new firebase.auth.OAuthProvider('microsoft.com');
const userCredential = await firebase.auth().currentUser.linkWithRedirect(provider);
```
Parameters
- provider: AuthProvider
  A created AuthProvider.
Returns Promise<UserCredential>
Error
auth/provider-already-linked Thrown if the provider has already been linked to the user. This error is thrown even if this is not the same provider's account that is currently linked to the user.

Error
auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method.

Error
auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User.

Error
auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users.

Error
auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider.

Error
auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid.

Error
auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password.

Error
auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid.

Error
auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

Throws
on iOS NativeFirebaseAuthError, on Android NativeFirebaseError
- Defined in auth/lib/index.d.ts:1415

reauthenticateWithCredential

reauthenticateWithCredential(
credential: AuthCredential,
): Promise<UserCredential>
Re-authenticate a user with a third-party authentication provider.

Example
```
const facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');
const userCredential = await firebase.auth().currentUser.reauthenticateWithCredential(facebookCredential);
```
Parameters
- credential: AuthCredential
  A created AuthCredential.
Returns Promise<UserCredential>
Error
auth/user-mismatch Thrown if the credential given does not correspond to the user.

Error
auth/user-not-found Thrown if the credential given does not correspond to any existing user.

Error
auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method.

Error
auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid.

Error
auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password.

Error
auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid.

Error
auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.
- Defined in auth/lib/index.d.ts:1436

reauthenticateWithPopup

reauthenticateWithPopup(provider: AuthProvider): Promise<UserCredential>
Re-authenticate a user with a federated authentication provider (Microsoft, Yahoo). For native platforms, this will open a browser window. pop-up equivalent on native platforms.
Parameters
- provider: AuthProvider
  The auth provider.
Returns Promise<UserCredential>
A promise that resolves with the user credentials.
- Defined in auth/lib/index.d.ts:1465

reauthenticateWithRedirect

reauthenticateWithRedirect(provider: AuthProvider): Promise<void>
Re-authenticate a user with a federated authentication provider (Microsoft, Yahoo). For native platforms, this will open a browser window.

Example
```
const provider = new firebase.auth.OAuthProvider('microsoft.com');
const userCredential = await firebase.auth().currentUser.reauthenticateWithProvider(provider);
```
Parameters
- provider: AuthProvider
  A created AuthProvider.
Returns Promise<void>
A promise that resolves with no value.

Error
auth/user-mismatch Thrown if the credential given does not correspond to the user.

Error
auth/user-not-found Thrown if the credential given does not correspond to any existing user.

Error
auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method.

Error
auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid.

Error
auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password.

Error
auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid.

Error
auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.
- Defined in auth/lib/index.d.ts:1457

reload

reload(): Promise<void>
Refreshes the current user.

Example
```
await firebase.auth().currentUser.reload();
```
Returns Promise<void>
- Defined in auth/lib/index.d.ts:1475

sendEmailVerification

sendEmailVerification(actionCodeSettings?: ActionCodeSettings): Promise<void>
Sends a verification email to a user.

Example
```
await firebase.auth().currentUser.sendEmailVerification({
  handleCodeInApp: true,
});
```
This will Promise reject if the user is anonymous.
Parameters
- OptionalactionCodeSettings: ActionCodeSettings
  Any optional additional settings to be set before sending the verification email.
Returns Promise<void>
Error
auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed.

Error
auth/missing-continue-uri A continue URL must be provided in the request.

Error
auth/missing-ios-bundle-id An iOS bundle ID must be provided if an App Store ID is provided.

Error
auth/invalid-continue-uri The continue URL provided in the request is invalid.

Error
auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console.
- Defined in auth/lib/index.d.ts:1497

toJSON

toJSON(): object
Returns a JSON-serializable representation of this object.

Example
```
const user = firebase.auth().currentUser.toJSON();
```
Returns object
- Defined in auth/lib/index.d.ts:1532

unlink

unlink(providerId: string): Promise<User>
Unlinks a provider from a user account.

Example
```
const user = await firebase.auth().currentUser.unlink('facebook.com');
```
Parameters
- providerId: string
Returns Promise<User>
Error
auth/no-such-provider Thrown if the user does not have this provider linked or when the provider ID given does not exist.
- Defined in auth/lib/index.d.ts:1546

updateEmail

updateEmail(email: string): Promise<void>
Updates the user's email address.

See Firebase docs for more information on security & email validation.

Example
```
await firebase.auth().currentUser.updateEmail('[email protected]');
```
This will Promise reject if the user is anonymous.
Parameters
- email: string
  The users new email address.
Returns Promise<void>
Error
auth/invalid-email Thrown if the email used is invalid.

Error
auth/email-already-in-use Thrown if the email is already used by another user.

Error
auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold.
- Defined in auth/lib/index.d.ts:1566

updatePassword

updatePassword(password: string): Promise<void>
Updates the users password.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate.

Example
```
await firebase.auth().currentUser.updatePassword('654321');
```
This will Promise reject is the user is anonymous.
Parameters
- password: string
  The users new password.
Returns Promise<void>
Error
auth/weak-password Thrown if the password is not strong enough.

Error
auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold.
- Defined in auth/lib/index.d.ts:1586

updatePhoneNumber

updatePhoneNumber(credential: AuthCredential): Promise<void>
Updates the user's phone number.

See Firebase docs for more information on security & email validation.

Example
```
const snapshot = await firebase.auth().verifyPhoneNumber('+4423456789')
 .on(...); // See PhoneAuthListener - wait for successful verification

const credential = firebase.auth.PhoneAuthProvider.credential(snapshot.verificationId, snapshot.code);

// Update user with new verified phone number
await firebase.auth().currentUser.updatePhoneNumber(credential);
```
This will Promise reject is the user is anonymous.
Parameters
- credential: AuthCredential
  A created PhoneAuthCredential.
Returns Promise<void>
Error
auth/invalid-verification-code Thrown if the verification code of the credential is not valid.

Error
auth/invalid-verification-id Thrown if the verification ID of the credential is not valid.
- Defined in auth/lib/index.d.ts:1611

updateProfile

updateProfile(updates: UpdateProfile): Promise<void>
Updates a user's profile data.

Example
```
await firebase.auth().currentUser.updateProfile({
  displayName: 'Alias',
});
```
Parameters
- updates: UpdateProfile
Returns Promise<void>
- Defined in auth/lib/index.d.ts:1624

verifyBeforeUpdateEmail

verifyBeforeUpdateEmail(
email: string,
actionCodeSettings?: ActionCodeSettings,
): Promise<void>
Sends a link to the user's email address, when clicked, the user's Authentication email address will be updated to whatever was passed as the first argument.

Example
```
await firebase.auth().currentUser.verifyBeforeUpdateEmail(
'[email protected]',
{
  handleCodeInApp: true,
});
```
This will Promise reject if the user is anonymous.
Parameters
- email: string
- OptionalactionCodeSettings: ActionCodeSettings
  Any optional additional settings to be set before sending the verification email.
Returns Promise<void>
Error
auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed.

Error
auth/missing-continue-uri A continue URL must be provided in the request.

Error
auth/missing-ios-bundle-id An iOS bundle ID must be provided if an App Store ID is provided.

Error
auth/invalid-continue-uri The continue URL provided in the request is invalid.

Error
auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console.
- Defined in auth/lib/index.d.ts:1521

Properties

displayName

displayName: string | null

The user's display name (if available).

email

email: string | null

The user's email address (if available).

emailVerified

emailVerified: boolean

True if the user's email address has been verified.

isAnonymous

isAnonymous: boolean

Returns true if the user is anonymous; that is, the user account was created with signInAnonymously and has not been linked to another account with linkWithCredential.

metadata

metadata: UserMetadata

Returns the UserMetadata associated with this user.

multiFactor

multiFactor: MultiFactor | null

Returns the MultiFactor associated with this user.

phoneNumber

phoneNumber: string | null

Returns the phone number of the user, as stored in the Firebase project's user database, or null if none exists. This can be updated at any time by calling User#updatePhoneNumber.

photoURL

photoURL: string | null

The URL of the user's profile picture (if available).

providerData

providerData: UserInfo[]

Additional provider-specific information about the user.

providerId

providerId: string

The authentication provider ID for the current user. For example, 'facebook.com', or 'google.com'.

uid

uid: string

The user's unique ID.

Interface User

Example 1

Example 2

Index

Methods

Properties

Methods

delete

Example

Returns Promise<void>

Error

getIdToken

Example

Parameters

Returns Promise<string>

getIdTokenResult

Example

Parameters

Returns Promise<IdTokenResult>

linkWithCredential

Example

Parameters

Returns Promise<UserCredential>

Error

Error

Error

Error

Error

Error

Error

Error

Error

Throws

linkWithPopup

Example

Parameters

Returns Promise<UserCredential>

Error

Error

Error

Error

Error

Error

Error

Error

Error

Throws

linkWithRedirect

Example

Parameters

Returns Promise<UserCredential>

Error

Error

Error

Error

Error

Error

Error

Error

Error

Throws

reauthenticateWithCredential

Example

Parameters

Returns Promise<UserCredential>

Error

Error

Error

Error

Error

Error

Error

reauthenticateWithPopup

Parameters

Returns Promise<UserCredential>

reauthenticateWithRedirect

Example

Parameters

Returns Promise<void>

Error