Properties

customClaims

(non-null Object or undefined)

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

boolean

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

displayName

(string or undefined)

The user's display name.

email

(string or undefined)

The user's primary email, if set.

emailVerified

boolean

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

metadata

non-null admin.auth.UserMetadata

Additional metadata about the user.

passwordHash

(string or undefined)

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

passwordSalt

(string or undefined)

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

phoneNumber

(string or undefined)

The user's primary phone number, if set.

photoURL

(string or undefined)

The user's photo URL.

providerData

non-null Array of non-null admin.auth.UserInfo

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

tokensValidAfterTime

(string or undefined)

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

string

The user's uid.

Method

toJSON

toJSON() returns Object

Returns a JSON-serializable representation of this object.

Returns

non-null Object A JSON-serializable representation of this object.