Интерфейс, представляющий пользователя для импорта в Firebase Auth с помощью метода BaseAuth.importUsers() .
Подпись:
export interface UserImportRecord
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
| пользовательские претензии | { [ключ: строка]: любой; } | Объект настраиваемых утверждений пользователя, если он доступен, обычно используется для определения ролей пользователя и распространяется на токен идентификатора прошедшего проверку подлинности пользователя. |
| неполноценный | логическое значение | Независимо от того, отключен ли пользователь: true для отключенного; false для включенного. |
| отображаемое имя | нить | Отображаемое имя пользователя. |
| электронная почта | нить | Основной адрес электронной почты пользователя, если он установлен. |
| электронная почтаПодтвержден | логическое значение | Подтвержден ли основной адрес электронной почты пользователя. |
| метаданные | Пользовательский запрос метаданных | Дополнительные метаданные о пользователе. |
| многофакторный | Параметры мультифакторобнопдате | Многофакторные связанные свойства пользователя. |
| парольХеш | Буфер | Буфер байтов, представляющий хешированный пароль пользователя. Если пользователя необходимо импортировать с помощью хэша пароля, необходимо указать UserImportOptions для идентификации алгоритма хеширования, используемого для создания этого хэша. |
| парольСоль | Буфер | Буфер байтов, представляющих соль пароля пользователя. |
| номер телефона | нить | Основной номер телефона пользователя, если он установлен. |
| фотоURL | нить | URL-адрес фотографии пользователя. |
| данные поставщика | Усерпровидеррекуест [] | Массив провайдеров (например, Google, Facebook), привязанных к пользователю. |
| идентификатор арендатора | нить | Идентификатор клиента, в который необходимо импортировать пользователя. Если он не указан в контексте admin.auth.Auth , пользователь загружается в родительский проект по умолчанию. Если он не указан в контексте admin.auth.TenantAwareAuth , пользователь загружается в клиент, соответствующий идентификатору клиента этого экземпляра TenantAwareAuth . |
| жидкость | нить | uid пользователя. |
UserImportRecord.customClaims
Объект настраиваемых утверждений пользователя, если он доступен, обычно используется для определения ролей пользователя и распространяется на токен идентификатора прошедшего проверку подлинности пользователя.
Подпись:
customClaims?: {
[key: string]: any;
};
UserImportRecord.disabled
Независимо от того, отключен ли пользователь: true для отключенного; false для включенного.
Подпись:
disabled?: boolean;
UserImportRecord.displayName
Отображаемое имя пользователя.
Подпись:
displayName?: string;
UserImportRecord.email
Основной адрес электронной почты пользователя, если он установлен.
Подпись:
email?: string;
UserImportRecord.emailVerified
Подтвержден ли основной адрес электронной почты пользователя.
Подпись:
emailVerified?: boolean;
Усеримпортрекорд.метаданные
Дополнительные метаданные о пользователе.
Подпись:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
Многофакторные связанные свойства пользователя.
Подпись:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
Буфер байтов, представляющий хешированный пароль пользователя. Если пользователя необходимо импортировать с помощью хэша пароля, необходимо указать UserImportOptions для идентификации алгоритма хеширования, используемого для создания этого хэша.
Подпись:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
Буфер байтов, представляющих соль пароля пользователя.
Подпись:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
Основной номер телефона пользователя, если он установлен.
Подпись:
phoneNumber?: string;
UserImportRecord.photoURL
URL-адрес фотографии пользователя.
Подпись:
photoURL?: string;
UserImportRecord.providerData
Массив провайдеров (например, Google, Facebook), привязанных к пользователю.
Подпись:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
Идентификатор клиента, в который необходимо импортировать пользователя. Если он не указан в контексте admin.auth.Auth , пользователь загружается в родительский проект по умолчанию. Если он не указан в контексте admin.auth.TenantAwareAuth , пользователь загружается в клиент, соответствующий идентификатору клиента этого экземпляра TenantAwareAuth .
Подпись:
tenantId?: string;
UserImportRecord.uid
uid пользователя .
Подпись:
uid: string;