واجهة تمثل مستخدمًا للاستيراد إلى Firebase Auth عبر طريقة BaseAuth.importUsers() .
إمضاء:
export interface UserImportRecord
ملكيات
ملكية | يكتب | وصف |
---|---|---|
customClaims | { [مفتاح: سلسلة]: أي؛ } | كائن المطالبات المخصصة للمستخدم، إذا كان متاحًا، يُستخدم عادةً لتحديد أدوار المستخدم ويتم نشره إلى رمز معرف مستخدم تمت مصادقته. |
عاجز | منطقية | ما إذا كان المستخدم معطلاً أم لا: true للمعاقين؛ false للتمكين. |
اسم العرض | خيط | اسم العرض الخاص بالمستخدم. |
بريد إلكتروني | خيط | البريد الإلكتروني الأساسي للمستخدم، إذا تم تعيينه. |
تم التحقق من البريد الإلكتروني | منطقية | ما إذا كان قد تم التحقق من البريد الإلكتروني الأساسي للمستخدم أم لا. |
البيانات الوصفية | طلب بيانات المستخدم | بيانات تعريف إضافية عن المستخدم. |
multiFactor | إعدادات تحديث العوامل المتعددة | الخصائص ذات الصلة متعددة العوامل للمستخدم. |
com.passwordHash | متعادل | المخزن المؤقت للبايت الذي يمثل كلمة المرور المجزأة للمستخدم. عندما يتم استيراد مستخدم بكلمة مرور، يلزم تحديد UserImportOptions لتحديد خوارزمية التجزئة المستخدمة لإنشاء هذا التجزئة. |
com.passwordSalt | متعادل | المخزن المؤقت للبايتات الذي يمثل ملح كلمة مرور المستخدم. |
رقم التليفون | خيط | رقم الهاتف الأساسي للمستخدم، إذا تم تعيينه. |
photoURL | خيط | عنوان URL لصورة المستخدم. |
ProvideData | طلب UserProviderRequest [] | مجموعة من مقدمي الخدمة (مثل Google وFacebook) المرتبطين بالمستخدم. |
معرف المستأجر | خيط | معرف المستأجر الذي سيتم استيراد المستخدم إليه. عند عدم توفيره في سياق admin.auth.Auth ، يتم تحميل المستخدم إلى المشروع الأصلي الافتراضي. عند عدم توفيره في سياق admin.auth.TenantAwareAuth ، يتم تحميل المستخدم إلى المستأجر المطابق لمعرف المستأجر الخاص بمثيل TenantAwareAuth . |
uid | خيط | uid المستخدم . |
UserImportRecord.customClaims
كائن المطالبات المخصصة للمستخدم، إذا كان متاحًا، يُستخدم عادةً لتحديد أدوار المستخدم ويتم نشره إلى رمز معرف مستخدم تمت مصادقته.
إمضاء:
customClaims?: {
[key: string]: any;
};
UserImportRecord.disabled
ما إذا كان المستخدم معطلاً أم لا: true
للمعاقين؛ false
للتمكين.
إمضاء:
disabled?: boolean;
UserImportRecord.displayName
اسم العرض الخاص بالمستخدم.
إمضاء:
displayName?: string;
UserImportRecord.email
البريد الإلكتروني الأساسي للمستخدم، إذا تم تعيينه.
إمضاء:
email?: string;
تم التحقق من UserImportRecord.email
ما إذا كان قد تم التحقق من البريد الإلكتروني الأساسي للمستخدم أم لا.
إمضاء:
emailVerified?: boolean;
UserImportRecord.metadata
بيانات تعريف إضافية عن المستخدم.
إمضاء:
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;