Go to console

Interface representing a user.

Index

Properties

Optional customClaims

customClaims: Object

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 setCustomUserClaims()

disabled

disabled: boolean

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

Optional displayName

displayName: string

The user's display name.

Optional email

email: string

The user's primary email, if set.

emailVerified

emailVerified: boolean

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

metadata

metadata: UserMetadata

Additional metadata about the user.

Optional passwordHash

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 listUsers().

Optional passwordSalt

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 listUsers().

Optional phoneNumber

phoneNumber: string

The user's primary phone number, if set.

Optional photoURL

photoURL: string

The user's photo URL.

providerData

providerData: UserInfo[]

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

Optional tokensValidAfterTime

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 revokeRefreshTokens() API or from the Firebase Auth backend on big account changes (password resets, password or email updates, etc).

uid

uid: string

The user's uid.

Methods