voluptasmollitia
Version:
Monorepo for the Firebase JavaScript SDK
37 lines (26 loc) • 1.99 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@firebase/auth](./auth.md) > [User](./auth.user.md)
## User interface
A user account.
<b>Signature:</b>
```typescript
export interface User extends UserInfo
```
<b>Extends:</b> [UserInfo](./auth.userinfo.md)
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [emailVerified](./auth.user.emailverified.md) | boolean | Whether the email has been verified with [sendEmailVerification()](./auth.sendemailverification.md) and [applyActionCode()](./auth.applyactioncode.md)<!-- -->. |
| [isAnonymous](./auth.user.isanonymous.md) | boolean | Whether the user is authenticated using the provider. |
| [metadata](./auth.user.metadata.md) | [UserMetadata](./auth.usermetadata.md) | Additional metadata around user creation and sign-in times. |
| [providerData](./auth.user.providerdata.md) | [UserInfo](./auth.userinfo.md)<!-- -->\[\] | Additional per provider such as displayName and profile information. |
| [refreshToken](./auth.user.refreshtoken.md) | string | Refresh token used to reauthenticate the user. Avoid using this directly and prefer [User.getIdToken()](./auth.user.getidtoken.md) to refresh the ID token instead. |
| [tenantId](./auth.user.tenantid.md) | string \| null | The user's tenant ID. |
## Methods
| Method | Description |
| --- | --- |
| [delete()](./auth.user.delete.md) | Deletes and signs out the user. |
| [getIdToken(forceRefresh)](./auth.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. |
| [getIdTokenResult(forceRefresh)](./auth.user.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. |
| [reload()](./auth.user.reload.md) | Refreshes the user, if signed in. |
| [toJSON()](./auth.user.tojson.md) | Returns a JSON-serializable representation of this object. |