ממשק המייצג משתמש לייבא ל-Firebase Auth באמצעות שיטת BaseAuth.importUsers() .
חֲתִימָה:
export interface UserImportRecord
נכסים
תכונה | סוּג | תיאור |
---|---|---|
תביעות מותאמות אישית | { [מפתח: מחרוזת]: כל; } | אובייקט התביעות המותאם אישית של המשתמש אם זמין, משמש בדרך כלל להגדרת תפקידי משתמש ומופץ לאסימון מזהה משתמש מאומת. |
נָכֶה | בוליאני | בין אם המשתמש מושבת או לא: true עבור מושבת; false עבור מופעל. |
הצג שם | חוּט | שם התצוגה של המשתמש. |
אימייל | חוּט | האימייל הראשי של המשתמש, אם מוגדר. |
emailVerified | בוליאני | האם האימייל הראשי של המשתמש מאומת או לא. |
מטא נתונים | UserMetadataRequest | מטא נתונים נוספים על המשתמש. |
multi-Factor | MultiFactorUpdateSettings | המאפיינים הקשורים לריבוי גורמים של המשתמש. |
passwordHash | בַּלָם | מאגר הבתים המייצג את סיסמת הגיבוב של המשתמש. כאשר יש לייבא משתמש עם hash של סיסמה, יש לציין את UserImportOptions כדי לזהות את אלגוריתם הגיבוב המשמש ליצירת hash זה. |
סיסמהSalt | בַּלָם | מאגר הבתים המייצג את הסיסמה של המשתמש. |
מספר טלפון | חוּט | מספר הטלפון הראשי של המשתמש, אם מוגדר. |
photoURL | חוּט | כתובת האתר של התמונה של המשתמש. |
providerData | UserProviderRequest [] | מערך של ספקים (לדוגמה, גוגל, פייסבוק) המקושרים למשתמש. |
זיהוי דייר | חוּט | המזהה של הדייר שאליו יש לייבא את המשתמש. כאשר לא מסופק בהקשר 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.emailVerified
האם האימייל הראשי של המשתמש מאומת או לא.
חֲתִימָה:
emailVerified?: boolean;
UserImportRecord.metadata
מטא נתונים נוספים על המשתמש.
חֲתִימָה:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
המאפיינים הקשורים לריבוי גורמים של המשתמש.
חֲתִימָה:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
מאגר הבתים המייצג את סיסמת הגיבוב של המשתמש. כאשר יש לייבא משתמש עם hash של סיסמה, יש לציין את UserImportOptions כדי לזהות את אלגוריתם הגיבוב המשמש ליצירת hash זה.
חֲתִימָה:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
מאגר הבתים המייצג את הסיסמה של המשתמש.
חֲתִימָה:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
מספר הטלפון הראשי של המשתמש, אם מוגדר.
חֲתִימָה:
phoneNumber?: string;
UserImportRecord.photoURL
כתובת האתר של התמונה של המשתמש.
חֲתִימָה:
photoURL?: string;
UserImportRecord.providerData
מערך של ספקים (לדוגמה, גוגל, פייסבוק) המקושרים למשתמש.
חֲתִימָה:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
המזהה של הדייר שאליו יש לייבא את המשתמש. כאשר לא מסופק בהקשר admin.auth.Auth
, המשתמש מועלה לפרויקט האב המוגדר כברירת מחדל. כאשר לא מסופק בהקשר admin.auth.TenantAwareAuth
, המשתמש מועלה לדייר בהתאם לזיהוי הדייר של אותו מופע TenantAwareAuth
.
חֲתִימָה:
tenantId?: string;
UserImportRecord.uid
uid
של המשתמש .
חֲתִימָה:
uid: string;