Home > @firebase/auth > User
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 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 identitfy the user to a Firebase service. |
reload() | Refreshes the user, if signed in. |
toJSON() | Returns a JSON-serializable representation of this object. |