Represents a user.

Constructors

Properties

customClaims?: {
    [key: string]: any;
}

The user's custom claims object if available, typically used to define user roles and propagated to an authenticated user's ID token. This is set via BaseAuth.setCustomUserClaims

Type declaration

  • [key: string]: any
disabled: boolean

Whether or not the user is disabled: true for disabled; false for enabled.

displayName?: string

The user's display name.

email?: string

The user's primary email, if set.

emailVerified: boolean

Whether or not the user's primary email is verified.

metadata: UserMetadata

Additional metadata about the user.

multiFactor?: MultiFactorSettings

The multi-factor related properties for the current user, if available.

passwordHash?: string

The user's hashed password (base64-encoded), only if Firebase Auth hashing algorithm (SCRYPT) is used. If a different hashing algorithm had been used when uploading this user, as is typical when migrating from another Auth system, this will be an empty string. If no password is set, this is null. This is only available when the user is obtained from BaseAuth.listUsers.

passwordSalt?: string

The user's password salt (base64-encoded), only if Firebase Auth hashing algorithm (SCRYPT) is used. If a different hashing algorithm had been used to upload this user, typical when migrating from another Auth system, this will be an empty string. If no password is set, this is null. This is only available when the user is obtained from BaseAuth.listUsers.

phoneNumber?: string

The user's primary phone number, if set.

photoURL?: string

The user's photo URL.

providerData: UserInfo[]

An array of providers (for example, Google, Facebook) linked to the user.

tenantId?: null | string

The ID of the tenant the user belongs to, if available.

tokensValidAfterTime?: string

The date the user's tokens are valid after, formatted as a UTC string. This is updated every time the user's refresh token are revoked either from the BaseAuth.revokeRefreshTokens API or from the Firebase Auth backend on big account changes (password resets, password or email updates, etc).

uid: string

The user's uid.

Methods

  • Returns a JSON-serializable representation of this object.

    Returns object

    A JSON-serializable representation of this object.