UserRecord class

Представляет пользователя.

Подпись:

export declare class UserRecord 

Характеристики

Методы

UserRecord.customClaims

Объект настраиваемых утверждений пользователя, если он доступен, обычно используется для определения ролей пользователя и распространяется на токен идентификатора прошедшего проверку подлинности пользователя. Это устанавливается через BaseAuth.setCustomUserClaims().

Подпись:

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

UserRecord.disabled

Независимо от того, отключен ли пользователь: true для отключенного; false для включенного.

Подпись:

readonly disabled: boolean;

UserRecord.displayName

Отображаемое имя пользователя.

Подпись:

readonly displayName?: string;

Пользовательская запись.электронная почта

Основной адрес электронной почты пользователя, если он установлен.

Подпись:

readonly email?: string;

UserRecord.emailVerified

Подтвержден ли основной адрес электронной почты пользователя.

Подпись:

readonly emailVerified: boolean;

Пользовательская запись.метаданные

Дополнительные метаданные о пользователе.

Подпись:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Свойства, связанные с многофакторностью, для текущего пользователя, если они доступны.

Подпись:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Хешированный пароль пользователя (в кодировке Base64), только если используется алгоритм хеширования аутентификации Firebase (SCRYPT). Если при загрузке этого пользователя использовался другой алгоритм хеширования, как это обычно бывает при переходе из другой системы аутентификации, это будет пустая строка. Если пароль не установлен, это значение равно нулю. Это доступно только в том случае, если пользователь получен из BaseAuth.listUsers(). .

Подпись:

readonly passwordHash?: string;

UserRecord.passwordSalt

Соль пароля пользователя (в кодировке Base64), только если используется алгоритм хеширования аутентификации Firebase (SCRYPT). Если для загрузки этого пользователя использовался другой алгоритм хеширования, что типично при переходе из другой системы аутентификации, это будет пустая строка. Если пароль не установлен, это значение равно нулю. Это доступно только в том случае, если пользователь получен из BaseAuth.listUsers(). .

Подпись:

readonly passwordSalt?: string;

UserRecord.phoneNumber

Основной номер телефона пользователя, если он установлен.

Подпись:

readonly phoneNumber?: string;

UserRecord.photoURL

URL-адрес фотографии пользователя.

Подпись:

readonly photoURL?: string;

UserRecord.providerData

Массив провайдеров (например, Google, Facebook), привязанных к пользователю.

Подпись:

readonly providerData: UserInfo[];

UserRecord.tenantId

Идентификатор клиента, которому принадлежит пользователь, если доступен.

Подпись:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Дата, после которой токены пользователя становятся действительными, в формате строки UTC. Он обновляется каждый раз, когда токен обновления пользователя отзывается либо из API BaseAuth.revokeRefreshTokens() , либо из бэкэнда Firebase Auth при больших изменениях учетной записи (сброс пароля, обновление пароля или электронной почты и т. д.).

Подпись:

readonly tokensValidAfterTime?: string;

Пользовательская запись.uid

uid пользователя .

Подпись:

readonly uid: string;

Пользовательская запись.toJSON()

Возвращает сериализуемое в формате JSON представление этого объекта.

Подпись:

toJSON(): object;

Возврат:

объект

Сериализуемое в формате JSON представление этого объекта.