Optional
Readonly
customThe 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
Readonly
disabledWhether or not the user is disabled: true
for disabled; false
for
enabled.
Optional
Readonly
displayThe user's display name.
Optional
Readonly
emailThe user's primary email, if set.
Readonly
emailWhether or not the user's primary email is verified.
Readonly
metadataAdditional metadata about the user.
Optional
Readonly
multiThe multi-factor related properties for the current user, if available.
Optional
Readonly
passwordThe 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.
Optional
Readonly
passwordThe 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.
Optional
Readonly
phoneThe user's primary phone number, if set.
Optional
Readonly
photoURLThe user's photo URL.
Readonly
providerAn array of providers (for example, Google, Facebook) linked to the user.
Optional
Readonly
tenantThe ID of the tenant the user belongs to, if available.
Optional
Readonly
tokensThe 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).
Readonly
uidThe user's uid
.
Represents a user.