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.

disabled

(boolean or undefined)

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

displayName

(string or undefined)

The user's display name.

email

(string or undefined)

The user's primary email, if set.

emailVerified

(boolean or undefined)

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

metadata

(non-null admin.auth.UserMetadata or undefined)

Additional metadata about the user.

passwordHash

(non-null Buffer or undefined)

The buffer of bytes representing the user’s hashed password. When a user is to be imported with a password hash, UserImportOptions are required to be specified to identify the hashing algorithm used to generate this hash.

passwordSalt

(non-null Buffer or undefined)

The buffer of bytes representing the user’s password salt.

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 or undefined)

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

uid

string

The user's uid.