User interface

A user account.

Signature:

export interface User extends UserInfo 

Extends: UserInfo

Properties

Property Type Description
emailVerified boolean Whether the email has been verified with sendEmailVerification() and applyActionCode().
isAnonymous boolean Whether the user is authenticated using the ProviderId.ANONYMOUS provider.
metadata UserMetadata Additional metadata around user creation and sign-in times.
providerData UserInfo[] Additional per provider such as displayName and profile information.
refreshToken string Refresh token used to reauthenticate the user. Avoid using this directly and prefer User.getIdToken() to refresh the ID token instead.
tenantId string | null The user's tenant ID.

Methods

Method Description
delete() Deletes and signs out the user.
getIdToken(forceRefresh) Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.
getIdTokenResult(forceRefresh) Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.
reload() Refreshes the user, if signed in.
toJSON() Returns a JSON-serializable representation of this object.

User.emailVerified

Whether the email has been verified with sendEmailVerification() and applyActionCode().

Signature:

readonly emailVerified: boolean;

User.isAnonymous

Whether the user is authenticated using the ProviderId.ANONYMOUS provider.

Signature:

readonly isAnonymous: boolean;

User.metadata

Additional metadata around user creation and sign-in times.

Signature:

readonly metadata: UserMetadata;

User.providerData

Additional per provider such as displayName and profile information.

Signature:

readonly providerData: UserInfo[];

User.refreshToken

Refresh token used to reauthenticate the user. Avoid using this directly and prefer User.getIdToken() to refresh the ID token instead.

Signature:

readonly refreshToken: string;

User.tenantId

The user's tenant ID.

This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project.

Signature:

readonly tenantId: string | null;

Example

// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';

// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.

User.delete()

Deletes and signs out the user.

This method is not supported on any User signed in by Auth instances created with a FirebaseServerApp.

Signature:

delete(): Promise<void>;

Returns:

Promise<void>

User.getIdToken()

Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.

Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one.

Signature:

getIdToken(forceRefresh?: boolean): Promise<string>;

Parameters

Parameter Type Description
forceRefresh boolean Force refresh regardless of token expiration.

Returns:

Promise<string>

User.getIdTokenResult()

Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.

Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one.

Signature:

getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;

Parameters

Parameter Type Description
forceRefresh boolean Force refresh regardless of token expiration.

Returns:

Promise<IdTokenResult>

User.reload()

Refreshes the user, if signed in.

Signature:

reload(): Promise<void>;

Returns:

Promise<void>

User.toJSON()

Returns a JSON-serializable representation of this object.

Signature:

toJSON(): object;

Returns:

object

A JSON-serializable representation of this object.