אימות Firebase
פונקציות
פוּנקצִיָה | תיאור |
---|---|
פונקציה (אפליקציה,...) | |
getAuth(אפליקציה) | מחזירה את מופע האימות המשויך ל- FirebaseApp שסופק . אם לא קיים מופע, מאתחל מופע Auth עם תלות ברירת מחדל ספציפית לפלטפורמה. |
initializeAuth(אפליקציה, deps) | מאתחל מופע Auth עם שליטה דקיקה על תלויות . |
פונקציה (אחסון,...) | |
getReactNativePersistence(אחסון) | מחזיר אובייקט התמדה שעוטף את AsyncStorage שיובאו מ- react-native או @react-native-community/async-storage , וניתן להשתמש בו בשדה תלות התמדה ב- initializeAuth() . |
function(auth,...) | |
applicationActionCode(auth, oobCode) | מחיל קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ לפס. |
beforeAuthStateChanged(auth, callback, onAbort) | הוספת התקשרות חוזרת חוסמת שפועלת לפני ששינוי מצב אישור מגדיר משתמש חדש. |
checkActionCode(auth, oobCode) | בודק קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ לפס. |
confirmPasswordReset(auth, oobCode, newPassword) | משלים את תהליך איפוס הסיסמה, בהינתן קוד אישור וסיסמה חדשה. |
connectAuthEmulator(auth, url, options) | משנה את מופע ה-Auth לתקשורת עם Firebase Auth Emulator, במקום שירותי Firebase Auth בייצור. |
createUserWithEmailAndPassword(אישור, דוא"ל, סיסמה) | יוצר חשבון משתמש חדש המשויך לכתובת הדואר האלקטרוני והסיסמה שצוינו. |
fetchSignInMethodsForEmail(auth, email) | מקבל את רשימת שיטות הכניסה האפשריות עבור כתובת האימייל הנתונה. שיטה זו מחזירה רשימה ריקה כאשר [הגנה על ספירת דוא"ל](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) מופעלת, ללא קשר למספר שיטות האימות הזמינות עבור ניתן מייל. |
getMultiFactorResolver(auth, error) | מספק MultiFactorResolver המתאים להשלמת זרימה מרובת גורמים. |
getRedirectResult(auth, resolver) | מחזירה UserCredential מתהליך הכניסה המבוסס על הפניה מחדש. |
initializeRecaptchaConfig(auth) | טוען את תצורת reCAPTCHA למופע Auth . |
isSignInWithEmailLink(auth, emailLink) | בודק אם קישור נכנס הוא כניסה עם קישור דוא"ל מתאים ל- signInWithEmailLink() . |
onAuthStateChanged(auth, nextOrObserver, שגיאה, הושלמה) | מוסיף צופה לשינויים במצב הכניסה של המשתמש. |
onIdTokenChanged(auth, nextOrObserver, שגיאה, הושלמה) | מוסיף צופה לשינויים באסימון הזיהוי של המשתמש המחובר. |
revokeAccessToken(auth, token) | מבטל את אסימון הגישה שניתן. כרגע תומך רק באסימוני גישה של Apple OAuth. |
sendPasswordResetEmail(auth, email, actionCodeSettings) | שולח אימייל לאיפוס סיסמה לכתובת הדוא"ל הנתונה. שיטה זו אינה שולפת שגיאה כאשר אין חשבון משתמש עם כתובת הדוא"ל הנתונה ו-[הגנה על ספירת דוא"ל](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) מופעלת . |
sendSignInLinkToEmail(auth, email, actionCodeSettings) | שולח קישור דוא"ל כניסה למשתמש עם האימייל שצוין. |
setPersistence(אישור, persistence) | משנה את סוג ההתמדה במופע ה-Auth עבור הפעלת Auth שנשמרה כעת ומחיל סוג זה של התמדה עבור בקשות כניסה עתידיות, כולל כניסה עם בקשות להפניה מחדש. |
signInAnonymously(auth) | נכנס באופן אסינכרוני כמשתמש אנונימי. |
signInWithCredential(auth, credential) | נכנס באופן אסינכרוני עם האישורים שניתנו. |
signInWithCustomToken(auth, customToken) | נכנס באופן אסינכרוני באמצעות אסימון מותאם אישית. |
signInWithEmailAndPassword(אישור, אימייל, סיסמה) | כניסה אסינכרונית באמצעות דואר אלקטרוני וסיסמה. |
signInWithEmailLink(auth, email, emailLink) | נכנס באופן אסינכרוני באמצעות אימייל וקישור דוא"ל כניסה. |
signInWithPhoneNumber(auth, phoneNumber, appVerifier) | נכנס באופן אסינכרוני באמצעות מספר טלפון. |
signInWithPopup(אישור, ספק, פותר) | מאמת לקוח Firebase באמצעות זרימת אימות OAuth מבוססת קופצים. |
signInWithRedirect(אישור, ספק, פותר) | מאמת לקוח Firebase באמצעות זרימת הפניה מחדש של דף מלא. |
signOut(auth) | מוציא את המשתמש הנוכחי. |
updateCurrentUser(auth, user) | מגדיר באופן אסינכרוני את המשתמש שסופק כ- Auth.currentUser במופע ה-Auth . |
useDeviceLanguage(auth) | מגדיר את השפה הנוכחית להעדפת ברירת המחדל של מכשיר/דפדפן. |
validatePassword(auth, password) | מאמת את הסיסמה מול מדיניות הסיסמאות שהוגדרה עבור הפרויקט או הדייר. |
verifyPasswordResetCode(auth, code) | בודק קוד איפוס סיסמה שנשלח למשתמש בדוא"ל או במנגנון אחר מחוץ לפס. |
פונקציה (קישור, ...) | |
parseActionCodeURL(קישור) | מנתח את מחרוזת הקישור לפעולת הדוא"ל ומחזירה ActionCodeURL אם הקישור חוקי, אחרת מחזירה null. |
פונקציה (משתמש, ...) | |
מחק משתמש (משתמש) | מוחק ומוציא את המשתמש. |
getIdToken(משתמש, forceRefresh) | מחזירה JSON Web Token (JWT) המשמש לזיהוי המשתמש לשירות Firebase. |
getIdTokenResult(משתמש, forceRefresh) | מחזירה JSON Web Token (JWT) המשמש לזיהוי המשתמש לשירות Firebase. |
linkWithCredential(משתמש, אישור) | מקשר את חשבון המשתמש עם האישורים שניתנו. |
linkWithPhoneNumber(משתמש, phoneNumber, appVerifier) | מקשר את חשבון המשתמש עם מספר הטלפון הנתון. |
linkWithPopup(משתמש, ספק, פותר) | מקשר את הספק המאומת לחשבון המשתמש באמצעות זרימת OAuth מבוססת קופץ. |
linkWithRedirect(משתמש, ספק, פותר) | מקשר את ה- OAuthProvider לחשבון המשתמש באמצעות זרימת הפניה מחדש של עמוד שלם. |
multiFactor (משתמש) | MultiFactorUser המתאים למשתמש. |
reauthenticateWithCredential(משתמש, אישור) | מאמת מחדש משתמש באמצעות אישור חדש. |
reauthenticateWithPhoneNumber(משתמש, מספר טלפון, appVerifier) | מאמת מחדש משתמש באמצעות אישור טלפון חדש. |
reauthenticateWithPopup(משתמש, ספק, פותר) | מאמת מחדש את המשתמש הנוכחי עם ה- OAuthProvider שצוין באמצעות זרימת OAuth מבוססת קופץ. |
reauthenticateWithRedirect(משתמש, ספק, פותר) | מאמת מחדש את המשתמש הנוכחי עם ה- OAuthProvider שצוין באמצעות זרימת הפניה מחדש של עמוד שלם. |
טען מחדש (משתמש) | טוען מחדש את נתוני חשבון המשתמש, אם הוא מחובר. |
sendEmailVerification(משתמש, actionCodeSettings) | שולח דוא"ל אימות למשתמש. |
unlink (user, providerId) | מבטל קישור של ספק מחשבון משתמש. |
updateEmail(משתמש, newEmail) | מעדכן את כתובת האימייל של המשתמש. |
updatePassword(משתמש, newPassword) | מעדכן את סיסמת המשתמש. |
updatePhoneNumber(משתמש, אישור) | מעדכן את מספר הטלפון של המשתמש. |
updateProfile(משתמש, { displayName, photoURL: photoUrl }) | מעדכן את נתוני הפרופיל של משתמש. |
verifyBeforeUpdateEmail (משתמש, newEmail, actionCodeSettings) | שולח דוא"ל אימות לכתובת דוא"ל חדשה. |
function (UserCredential, ...) | |
getAdditionalUserInfo(UserCredential) | מחלץ מידע נוסף על משתמש ספציפי לספק עבור האישור הנתון. |
שיעורים
מעמד | תיאור |
---|---|
ActionCodeURL | מחלקת שירות לניתוח כתובות אתרים של פעולות דוא"ל כגון איפוס סיסמה, אימות דוא"ל, כניסה לקישור דוא"ל וכו'. |
AuthCredential | ממשק המייצג את האישורים המוחזרים על ידי AuthProvider . |
EmailAuthCredential | ממשק המייצג את האישורים המוחזרים על ידי EmailAuthProvider עבור ProviderId .סיסמה |
EmailAuthProvider | ספק להפקת EmailAuthCredential . |
FacebookAuthProvider | ספק להפקת OAuthCredential עבור ProviderId .פייסבוק. |
GithubAuthProvider | ספק להפקת OAuthCredential עבור ProviderId GITHUB. |
GoogleAuthProvider | ספק להפקת OAuthCredential עבור ProviderId .GOOGLE. |
OAuthCredential | מייצג את אישורי ה-OAuth שהוחזרו על ידי ספק OAuth . |
OAuthProvider | ספק להפקת OAuthCredential גנרי . |
PhoneAuthCredential | מייצג את האישורים שהוחזרו על ידי PhoneAuthProvider . |
PhoneAuthProvider | ספק להפקת PhoneAuthCredential . |
PhoneMultiFactorGenerator | ספק להפקת PhoneMultiFactorAssertion . |
RecaptchaVerifier | reCAPTCHA מאמת יישומים מבוסס. |
SAMLAuthProvider | AuthProvider עבור SAML. |
TotpMultiFactorGenerator | ספק להפקת TotpMultiFactorAssertion . |
TotpSecret | ספק להפקת TotpMultiFactorAssertion . מאחסן את המפתח הסודי המשותף ופרמטרים אחרים ליצירת OTP מבוססי זמן. מיישמת שיטות לאחזור המפתח הסודי המשותף ויצירת כתובת URL של קוד QR. |
TwitterAuthProvider | ספק להפקת OAuthCredential עבור ProviderId .טוויטר. |
ממשקים
מִמְשָׁק | תיאור |
---|---|
ActionCodeInfo | תגובה מאת checkActionCode() . |
ActionCodeSettings | ממשק המגדיר את כתובת האתר הנדרשת להמשך/מצב עם מזהי חבילה אופציונליים של Android ו-iOS. |
מידע נוסף על המשתמש | מבנה המכיל מידע משתמש נוסף מספק זהות מאוחד. |
ApplicationVerifier | מאמת לאימות דומיין ומניעת שימוש לרעה. |
Auth | ממשק המייצג את שירות Firebase Auth. |
AuthError | ממשק לשגיאת Auth . |
AuthErrorMap | מיפוי של קודי שגיאה להודעות שגיאה. |
AuthProvider | ממשק המייצג ספק אישור, המשמש להקלת יצירת אישור אישור . |
AuthSettings | ממשק המייצג הגדרות של מופע Auth . |
Config | ממשק המייצג את תצורת Auth . |
אישור תוצאה | תוצאה של כניסה למספר טלפון, קישור או שיחה מאימות מחדש. |
תלות | התלות שבהן ניתן להשתמש כדי לאתחל מופע Auth . |
EmulatorConfig | תצורה של אמולטור אימות Firebase. |
IdTokenResult | ממשק המייצג תוצאת אסימון מזהה שהתקבלה מ- User.getIdTokenResult() . |
MultiFactorAssertion | מעמד הבסיס לקביעת בעלות על גורם שני. |
MultiFactorError | השגיאה שנרשמה כאשר המשתמש צריך לספק גורם שני כדי להיכנס בהצלחה. |
MultiFactorInfo | מבנה המכיל מידע של ישות גורם שניה. |
MultiFactorResolver | המחלקה המשמשת כדי להקל על התאוששות מ- MultiFactorError כאשר משתמש צריך לספק גורם שני כדי להיכנס. |
MultiFactorSession | ממשק המגדיר את אובייקט ההפעלה מרובה הגורמים המשמש לרישום גורם שני על משתמש או מסייע בכניסה למשתמש רשום עם גורם שני. |
MultiFactorUser | ממשק המגדיר את המאפיינים והפעולות הקשורים לריבוי גורמים הקשורים למשתמש . |
OAuthCredentialOptions | מגדיר את האפשרויות לאתחול OAuthCredential . |
ParsedToken | ממשק המייצג אסימון מזהה מנותח. |
מדיניות סיסמאות | מבנה המציין דרישות מדיניות סיסמאות. |
Password Validation Status | מבנה המציין אילו דרישות מדיניות סיסמאות התקיימו או הופרו ומהן הדרישות. |
הַתמָדָה | ממשק המכסה את סוגי מנגנון ההתמדה האפשריים. |
PhoneMultiFactorAssertion | המעמד להצהרת בעלות על גורם טלפון שני. מסופק על ידי PhoneMultiFactorGenerator.assertion() . |
PhoneMultiFactorEnrollInfoOptions | אפשרויות המשמשות לרישום גורם שני. |
PhoneMultiFactorInfo | תת המחלקה של ממשק MultiFactorInfo עבור מספר טלפון שני גורמים. ה- factorId של הגורם השני הזה הוא FactorId .טלפון. |
PhoneMultiFactorSignInInfoOptions | אפשרויות המשמשות לכניסה עם גורם שני. |
PhoneSingleFactorInfoOptions | אפשרויות המשמשות לכניסה עם גורם יחיד. |
PopupRedirectResolver | פותר המשמש לטיפול בפעולות DOM ספציפיות כמו signInWithPopup() או signInWithRedirect() . |
ReactNativeAsyncStorage | ממשק עבור AsyncStorage שסופק. |
RecaptchaParameters | ממשק המייצג פרמטרים של reCAPTCHA. עיין ב-[reCAPTCHA docs](https://developers.google.com/recaptcha/docs/display#render_param) לקבלת רשימת הפרמטרים המקובלים. כל הפרמטרים מתקבלים מלבד sitekey : Firebase Auth מספק reCAPTCHA עבור כל פרויקט ויגדיר את מפתח האתר עם העיבוד. עבור reCAPTCHA בלתי נראה, הגדר את מפתח size לבלתי invisible . |
TotpMultiFactorAssertion | המעמד להצהרת בעלות על גורם שני של TOTP. מסופק על ידי TotpMultiFactorGenerator.assertionForEnrollment() ו- TotpMultiFactorGenerator.assertionForSignIn() . |
TotpMultiFactorInfo | תת המחלקה של ממשק MultiFactorInfo עבור גורמים שניים של TOTP. ה- factorId של הגורם השני הזה הוא FactorId .TOTP. |
מִשׁתַמֵשׁ | חשבון משתמש. |
תעודת משתמש | מבנה המכיל משתמש , ה- OperationType , ומזהה הספק. |
מידע על משתמש | מידע על פרופיל משתמש, גלוי רק לאפליקציות של פרויקט Firebase. |
User Metadata | ממשק המייצג מטא נתונים של משתמש. |
משתנים
מִשְׁתַנֶה | תיאור |
---|---|
ActionCodeOperation | ספירה של סוגי פעולות הדוא"ל האפשריים. |
AuthErrorCodes | מפה של קודי שגיאה פוטנציאליים Auth , להשוואה קלה יותר עם שגיאות שנזרקו על ידי ה-SDK. |
דפדפןLocalPersistence | יישום של Persistence מסוג LOCAL באמצעות localStorage עבור האחסון הבסיסי. |
דפדפןPopupRedirectResolver | יישום של PopupRedirectResolver המתאים ליישומים מבוססי דפדפן. |
browserSessionPersistence | יישום של Persistence of SESSION באמצעות sessionStorage עבור האחסון הבסיסי. |
cordovaPopupRedirectResolver | יישום של PopupRedirectResolver המתאים ליישומים מבוססי Cordova. |
debugErrorMap | מפת שגיאות מפורטת עם תיאורים מפורטים עבור רוב קודי השגיאה. ראה דיון ב- AuthErrorMap |
FactorId | אוסף של גורמים שעשוי לשמש לאימות מרובה גורמים. |
indexedDBLocalPersistence | יישום של Persistence מסוג LOCAL באמצעות indexedDB עבור האחסון הבסיסי. |
inMemoryPersistence | יישום של Persistence מסוג 'NONE'. |
OperationType | ספירת סוגי פעולות נתמכות. |
prodErrorMap | מפת שגיאות מינימלית עם כל הודעות השגיאה המילוליות שהוסרו. ראה דיון ב- AuthErrorMap |
ProviderId | ספירת ספקים נתמכים. |
שיטת כניסה | ספירת שיטות כניסה נתמכות. |
הקלד כינויים
הקלד כינוי | תיאור |
---|---|
פרמטרים מותאמים אישית | מפה של פרמטרים מותאמים אישית של OAuth. |
NextOrObserver | סוג הגדרה עבור התקשרות חוזרת לאירוע. |
PhoneInfoOptions | המידע הנדרש לאימות הבעלות על מספר טלפון. |
פרופיל משתמש | פרופיל משתמש בשימוש ב- AdditionalUserInfo . |
פונקציה (אפליקציה,...)
getAuth(אפליקציה)
מחזירה את מופע האימות המשויך ל- FirebaseApp שסופק . אם לא קיים מופע, מאתחל מופע Auth עם תלות ברירת מחדל ספציפית לפלטפורמה.
חֲתִימָה:
export declare function getAuth(app?: FirebaseApp): Auth;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אפליקציה | FirebaseApp | אפליקציית Firebase. |
החזרות:
initializeAuth(אפליקציה, deps)
מאתחל מופע Auth עם שליטה דקיקה על תלויות .
פונקציה זו מאפשרת שליטה רבה יותר על מופע ה- Auth מאשר getAuth() . getAuth
משתמש בברירות מחדל ספציפיות לפלטפורמה כדי לספק את התלות . באופן כללי, getAuth
היא הדרך הקלה ביותר לאתחל Auth ועובדת עבור רוב מקרי השימוש. השתמש initializeAuth
אם אתה צריך שליטה באיזו שכבת התמדה משמשת, או כדי למזער את גודל החבילה אם אינך משתמש ב- signInWithPopup
או signInWithRedirect
.
לדוגמה, אם האפליקציה שלך משתמשת רק בחשבונות אנונימיים ואתה רוצה שחשבונות יישמרו רק עבור ההפעלה הנוכחית, אתחל את Auth
באמצעות:
const auth = initializeAuth(app, {
persistence: browserSessionPersistence,
popupRedirectResolver: undefined,
});
חֲתִימָה:
export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אפליקציה | FirebaseApp | |
deps | תלות |
החזרות:
פונקציה (אחסון,...)
getReactNativePersistence(אחסון)
מחזירה אובייקט התמדה שעוטף את AsyncStorage
מיובא מ- react-native
או @react-native-community/async-storage
, וניתן להשתמש בו בשדה התלות בהתמדה ב- initializeAuth() .
חֲתִימָה:
export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אִחסוּן | ReactNativeAsyncStorage |
החזרות:
function(auth,...)
applicationActionCode(auth, oobCode)
מחיל קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ לפס.
חֲתִימָה:
export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
oobCode | חוּט | קוד אימות שנשלח למשתמש. |
החזרות:
הבטחה<void>
beforeAuthStateChanged(auth, callback, onAbort)
הוספת התקשרות חוזרת חוסמת שפועלת לפני ששינוי מצב אישור מגדיר משתמש חדש.
חֲתִימָה:
export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
התקשר חזרה | (משתמש: משתמש | null) => ריק | הבטחה<void> | התקשרות חוזרת מופעלת לפני הגדרת ערך משתמש חדש. אם זה זורק, זה חוסם את המשתמש מלהיות מוגדר. |
על ביטול | () => בטל | התקשרות חוזרת מופעלת אם התקשרות חוזרת מאוחרת יותר beforeAuthStateChanged() זורקת, ומאפשרת לך לבטל תופעות לוואי כלשהן. |
החזרות:
checkActionCode(auth, oobCode)
בודק קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ לפס.
חֲתִימָה:
export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
oobCode | חוּט | קוד אימות שנשלח למשתמש. |
החזרות:
הבטחה< ActionCodeInfo >
מטא נתונים על הקוד.
confirmPasswordReset(auth, oobCode, newPassword)
משלים את תהליך איפוס הסיסמה, בהינתן קוד אישור וסיסמה חדשה.
חֲתִימָה:
export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
oobCode | חוּט | קוד אישור שנשלח למשתמש. |
סיסמה חדשה | חוּט | הסיסמה החדשה. |
החזרות:
הבטחה<void>
connectAuthEmulator(auth, url, options)
משנה את מופע ה-Auth לתקשורת עם Firebase Auth Emulator, במקום שירותי Firebase Auth בייצור.
יש לקרוא לזה באופן סינכרוני מיד לאחר הקריאה הראשונה לאתחול Auth() . אין להשתמש עם אישורי ייצור מכיוון שתעבורת האמולטור אינה מוצפנת.
חֲתִימָה:
export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
disableWarnings: boolean;
}): void;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
כתובת אתר | חוּט | כתובת האתר שבה האמולטור פועל (למשל, 'http://localhost:9099'). |
אפשרויות | { disableWarnings: boolean; } | אופציונאלי. ברירת המחדל options.disableWarnings היא false . הגדר אותו כ- true כדי להשבית את באנר האזהרה המצורף ל-DOM. |
החזרות:
בָּטֵל
דוגמא
connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });
createUserWithEmailAndPassword(אישור, דוא"ל, סיסמה)
יוצר חשבון משתמש חדש המשויך לכתובת הדואר האלקטרוני והסיסמה שצוינו.
עם יצירה מוצלחת של חשבון המשתמש, משתמש זה ייכנס גם לאפליקציה שלך.
יצירת חשבון משתמש עלולה להיכשל אם החשבון כבר קיים או שהסיסמה לא חוקית.
חֲתִימָה:
export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
אימייל | חוּט | כתובת האימייל של המשתמש. |
סיסמה | חוּט | הסיסמה שנבחרה של המשתמש. |
החזרות:
הבטחה< UserCredential >
fetchSignInMethodsForEmail(auth, email)
מקבל את רשימת שיטות הכניסה האפשריות עבור כתובת האימייל הנתונה. שיטה זו מחזירה רשימה ריקה כאשר [הגנה על ספירת דוא"ל](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) מופעלת, ללא קשר למספר שיטות האימות הזמינות עבור ניתן מייל.
זה שימושי כדי להבדיל בין שיטות כניסה עבור אותו ספק, למשל. EmailAuthProvider שיש לו 2 שיטות כניסה, SignInMethod .EMAIL_PASSWORD ו- SignInMethod .EMAIL_LINK.
חֲתִימָה:
export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
אימייל | חוּט | כתובת האימייל של המשתמש. הוצא משימוש. העברת שיטה זו מומלצת כשיטת אבטחה מומלצת. למידע נוסף בתיעוד של פלטפורמת זהות עבור [הגנה על ספירת אימייל](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection). |
החזרות:
הבטחה<string[]>
getMultiFactorResolver(auth, error)
מספק MultiFactorResolver המתאים להשלמת זרימה מרובת גורמים.
חֲתִימָה:
export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
שְׁגִיאָה | MultiFactorError | MultiFactorError שהועלתה במהלך כניסה או פעולת אימות מחדש. |
החזרות:
getRedirectResult(auth, resolver)
מחזירה UserCredential מתהליך הכניסה המבוסס על הפניה מחדש.
אם הכניסה הצליחה, מחזירה את המשתמש המחובר. אם הכניסה לא הצליחה, נכשל עם שגיאה. אם לא נקראה פעולת הפניה מחדש, מחזירה null
.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
פותר | PopupRedirectResolver | מופע של PopupRedirectResolver , אופציונלי אם כבר מסופק ל- initializeAuth() או מסופק על-ידי getAuth() . |
החזרות:
הבטחה< UserCredential | null>
דוגמא
// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app
// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
// This is the signed-in user
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;
initializeRecaptchaConfig(auth)
טוען את תצורת reCAPTCHA למופע Auth
.
פעולה זו תטען את תצורת reCAPTCHA, המציינת אם יש להפעיל את זרימת האימות של reCAPTCHA עבור כל ספק אישור, לתוך הפעלת האימות הנוכחית.
אם initializeRecaptchaConfig() לא מופעל, זרימת ההרשאה תתחיל תמיד ללא אימות reCAPTCHA. אם הספק מוגדר לדרוש אימות reCAPTCHA, ה-SDK יטען בשקיפות את תצורת reCAPTCHA ויתחיל מחדש את זרימות האימות.
לפיכך, על ידי קריאה לשיטה אופציונלית זו, תפחית את זמן האחזור של זרימות אימות עתידיות. טעינה מוקדמת של תצורת reCAPTCHA תשפר גם את האות שנאסף על ידי reCAPTCHA.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
החזרות:
הבטחה<void>
דוגמא
initializeRecaptchaConfig(auth);
isSignInWithEmailLink(auth, emailLink)
בודק אם קישור נכנס הוא כניסה עם קישור דוא"ל מתאים ל- signInWithEmailLink() .
חֲתִימָה:
export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
emailLink | חוּט | הקישור נשלח לכתובת האימייל של המשתמש. |
החזרות:
בוליאני
onAuthStateChanged(auth, nextOrObserver, שגיאה, הושלמה)
מוסיף צופה לשינויים במצב הכניסה של המשתמש.
כדי לשמור על ההתנהגות הישנה, ראה onIdTokenChanged() .
חֲתִימָה:
export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
nextOrObserver | NextOrObserver < משתמש > | התקשרות חוזרת מופעלת בשינוי. |
שְׁגִיאָה | ErrorFn | הוצא משימוש. התקשרות חוזרת זו לעולם אינה מופעלת. שגיאות בכניסה/יציאה יכולות להיתפס בהבטחות המוחזרות מפונקציות כניסה/יציאה. |
הושלם | CompleteFn | הוצא משימוש. התקשרות חוזרת זו לעולם אינה מופעלת. |
החזרות:
onIdTokenChanged(auth, nextOrObserver, שגיאה, הושלמה)
מוסיף צופה לשינויים באסימון הזיהוי של המשתמש המחובר.
זה כולל אירועי כניסה, יציאה ורענון אסימון. זה לא יופעל אוטומטית עם פקיעת תוקף אסימון הזיהוי. השתמש ב- User.getIdToken() כדי לרענן את אסימון הזיהוי.
חֲתִימָה:
export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
nextOrObserver | NextOrObserver < משתמש > | התקשרות חוזרת מופעלת בשינוי. |
שְׁגִיאָה | ErrorFn | הוצא משימוש. התקשרות חוזרת זו לעולם אינה מופעלת. שגיאות בכניסה/יציאה יכולות להיתפס בהבטחות המוחזרות מפונקציות כניסה/יציאה. |
הושלם | CompleteFn | הוצא משימוש. התקשרות חוזרת זו לעולם אינה מופעלת. |
החזרות:
revokeAccessToken(auth, token)
מבטל את אסימון הגישה שניתן. כרגע תומך רק באסימוני גישה של Apple OAuth.
חֲתִימָה:
export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
אֲסִימוֹן | חוּט | אסימון הגישה של Apple OAuth. |
החזרות:
הבטחה<void>
sendPasswordResetEmail(auth, email, actionCodeSettings)
שולח אימייל לאיפוס סיסמה לכתובת הדוא"ל הנתונה. שיטה זו אינה שולפת שגיאה כאשר אין חשבון משתמש עם כתובת הדוא"ל הנתונה ו-[הגנה על ספירת דוא"ל](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) מופעלת .
כדי להשלים את איפוס הסיסמה, התקשר ל- confirmPasswordReset() עם הקוד שסופק באימייל שנשלח למשתמש, יחד עם הסיסמה החדשה שצוינה על ידי המשתמש.
חֲתִימָה:
export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
אימייל | חוּט | כתובת האימייל של המשתמש. |
actionCodeSettings | ActionCodeSettings | הגדרות ActionCode . |
החזרות:
הבטחה<void>
דוגמא
const actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);
sendSignInLinkToEmail(auth, email, actionCodeSettings)
שולח קישור דוא"ל כניסה למשתמש עם האימייל שצוין.
יש להשלים תמיד את פעולת הכניסה באפליקציה בניגוד לפעולות דוא"ל אחרות מחוץ לתחום (איפוס סיסמה ואימותי דוא"ל). הסיבה לכך היא שבסוף הזרימה, המשתמש צפוי להיות מחובר ומצב האימות שלו יישאר באפליקציה.
כדי להשלים את הכניסה באמצעות קישור הדוא"ל, התקשר ל-signInWithEmailLink() עם כתובת הדוא"ל וקישור הדוא"ל שסופקו בדוא"ל שנשלח למשתמש.
חֲתִימָה:
export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | |
אימייל | חוּט | כתובת האימייל של המשתמש. |
actionCodeSettings | ActionCodeSettings | הגדרות ActionCode . |
החזרות:
הבטחה<void>
דוגמא
const actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
await signInWithEmailLink(auth, 'user@example.com', emailLink);
}
setPersistence(אישור, persistence)
משנה את סוג ההתמדה במופע ה-Auth עבור הפעלת Auth
שנשמרה כעת ומחיל סוג זה של התמדה עבור בקשות כניסה עתידיות, כולל כניסה עם בקשות להפניה מחדש.
זה מקל על משתמש שנכנס לחשבון לציין אם יש לזכור את ההפעלה שלו או לא. זה גם מקל על לעולם לא להתמיד במצב Auth
עבור יישומים המשותפים על ידי משתמשים אחרים או שיש להם נתונים רגישים.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
הַתמָדָה | הַתמָדָה | ההתמדה לשימוש. |
החזרות:
הבטחה<void>
Promise
שנפתרת לאחר ששינוי ההתמדה הושלם
דוגמא
setPersistence(auth, browserSessionPersistence);
signInAnonymously(auth)
נכנס באופן אסינכרוני כמשתמש אנונימי.
אם כבר משתמש אנונימי מחובר, המשתמש הזה יוחזר; אחרת, זהות משתמש אנונימית חדשה תיווצר ותוחזר.
חֲתִימָה:
export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
החזרות:
הבטחה< UserCredential >
signInWithCredential(auth, credential)
נכנס באופן אסינכרוני עם האישורים שניתנו.
ניתן להשתמש ב- AuthProvider כדי ליצור את האישור.
חֲתִימָה:
export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
תְעוּדָה | AuthCredential | האישור. |
החזרות:
הבטחה< UserCredential >
signInWithCustomToken(auth, customToken)
נכנס באופן אסינכרוני באמצעות אסימון מותאם אישית.
אסימונים מותאמים אישית משמשים לשילוב Firebase Auth עם מערכות אימות קיימות, וחייבים להיווצר על ידי קצה אחורי של אימות באמצעות שיטת createCustomToken ב- Admin SDK .
נכשל עם שגיאה אם האסימון לא חוקי, פג תוקפו או לא מתקבל על ידי שירות Firebase Auth.
חֲתִימָה:
export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
customToken | חוּט | האסימון המותאם אישית שאפשר להיכנס איתו. |
החזרות:
הבטחה< UserCredential >
signInWithEmailAndPassword(אישור, אימייל, סיסמה)
כניסה אסינכרונית באמצעות דואר אלקטרוני וסיסמה.
נכשל עם שגיאה אם כתובת האימייל והסיסמה אינן תואמות. כאשר [הגנה על ספירת דוא"ל](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) מופעלת, שיטה זו נכשלת עם "auth/invalid-credential" במקרה של אישור לא חוקי אימייל/סיסמה.
חֲתִימָה:
export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
אימייל | חוּט | כתובת האימייל של המשתמש. |
סיסמה | חוּט | סיסמת המשתמשים. |
החזרות:
הבטחה< UserCredential >
signInWithEmailLink(auth, email, emailLink)
נכנס באופן אסינכרוני באמצעות אימייל וקישור דוא"ל כניסה.
אם לא מועבר קישור, הקישור מתקבל מכתובת האתר הנוכחית.
נכשל עם שגיאה אם כתובת הדוא"ל אינה חוקית או שה-OTP בקישור הדוא"ל יפוג.
חֲתִימָה:
export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
אימייל | חוּט | כתובת האימייל של המשתמש. |
emailLink | חוּט | הקישור נשלח לכתובת האימייל של המשתמש. |
החזרות:
הבטחה< UserCredential >
דוגמא
const actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
await signInWithEmailLink(auth, 'user@example.com', emailLink);
}
signInWithPhoneNumber(auth, phoneNumber, appVerifier)
נכנס באופן אסינכרוני באמצעות מספר טלפון.
שיטה זו שולחת קוד באמצעות SMS למספר הטלפון הנתון, ומחזירה ConfirmationResult . לאחר שהמשתמש מספק את הקוד שנשלח לטלפון שלו, התקשר ל- ConfirmationResult.confirm() עם הקוד כדי להיכנס למשתמש.
למניעת שימוש לרעה, שיטה זו דורשת גם ApplicationVerifier . SDK זה כולל מימוש מבוסס reCAPTCHA, RecaptchaVerifier . פונקציה זו יכולה לעבוד בפלטפורמות אחרות שאינן תומכות ב- RecaptchaVerifier (כמו React Native), אך עליך להשתמש ביישום ApplicationVerifier של צד שלישי.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
מספר טלפון | חוּט | מספר הטלפון של המשתמש בפורמט E.164 (לדוגמה +165055550101). |
appVerifier | ApplicationVerifier | ApplicationVerifier . |
החזרות:
הבטחה< ConfirmationResult >
דוגמא
// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);
signInWithPopup(אישור, ספק, פותר)
מאמת לקוח Firebase באמצעות זרימת אימות OAuth מבוססת קופצים.
אם זה מצליח, מחזיר את המשתמש המחובר יחד עם האישור של הספק. אם הכניסה לא הצליחה, מחזירה אובייקט שגיאה המכיל מידע נוסף על השגיאה.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
ספק | AuthProvider | הספק לאימות. הספק חייב להיות OAuthProvider . ספקים שאינם OAuth כמו EmailAuthProvider יזרוק שגיאה. |
פותר | PopupRedirectResolver | מופע של PopupRedirectResolver , אופציונלי אם כבר מסופק ל- initializeAuth() או מסופק על-ידי getAuth() . |
החזרות:
הבטחה< UserCredential >
דוגמא
// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;
signInWithRedirect(אישור, ספק, פותר)
מאמת לקוח Firebase באמצעות זרימת הפניה מחדש של דף מלא.
כדי לטפל בתוצאות ובשגיאות עבור פעולה זו, עיין ב- getRedirectResult() . פעל לפי השיטות המומלצות בעת שימוש ב-signInWithRedirect() .
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
ספק | AuthProvider | הספק לאימות. הספק חייב להיות OAuthProvider . ספקים שאינם OAuth כמו EmailAuthProvider יזרוק שגיאה. |
פותר | PopupRedirectResolver | מופע של PopupRedirectResolver , אופציונלי אם כבר מסופק ל- initializeAuth() או מסופק על-ידי getAuth() . |
החזרות:
הבטחה<לעולם לא>
דוגמא
// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app
// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
// This is the signed-in user
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;
signOut(auth)
מוציא את המשתמש הנוכחי.
חֲתִימָה:
export declare function signOut(auth: Auth): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
החזרות:
הבטחה<void>
updateCurrentUser(auth, user)
מגדיר באופן אסינכרוני את המשתמש שסופק כ- Auth.currentUser במופע ה-Auth .
עותק מופע חדש של המשתמש שסופק ייווצר ויוגדר כמשתמש הנוכחי.
זה יפעיל מאזינים onAuthStateChanged() ו- onIdTokenChanged() כמו שיטות כניסה אחרות.
הפעולה נכשלת עם שגיאה אם המשתמש שיש לעדכן שייך לפרויקט Firebase אחר.
חֲתִימָה:
export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
מִשׁתַמֵשׁ | משתמש | ריק | המשתמש החדש . |
החזרות:
הבטחה<void>
useDeviceLanguage(auth)
מגדיר את השפה הנוכחית להעדפת ברירת המחדל של מכשיר/דפדפן.
חֲתִימָה:
export declare function useDeviceLanguage(auth: Auth): void;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
החזרות:
בָּטֵל
validatePassword(auth, password)
מאמת את הסיסמה מול מדיניות הסיסמאות שהוגדרה עבור הפרויקט או הדייר.
אם לא הוגדר מזהה דייר במופע Auth
, שיטה זו תשתמש במדיניות הסיסמה שהוגדרה עבור הפרויקט. אחרת, שיטה זו תשתמש במדיניות שהוגדרה עבור השוכר. אם לא הוגדרה מדיניות סיסמה, תשמש מדיניות ברירת המחדל שהוגדרה עבור כל הפרויקטים.
אם זרימת אימות נכשלת מכיוון שסיסמה שנשלחה אינה עומדת בדרישות מדיניות הסיסמאות ושיטה זו נקראה בעבר, שיטה זו תשתמש במדיניות העדכנית ביותר הזמינה כאשר תקרא שוב.
חֲתִימָה:
export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
סיסמה | חוּט | הסיסמה לאימות. |
החזרות:
הבטחה< PasswordValidationStatus >
דוגמא
validatePassword(auth, 'some-password');
verifyPasswordResetCode(auth, code)
בודק קוד איפוס סיסמה שנשלח למשתמש בדוא"ל או במנגנון אחר מחוץ לפס.
חֲתִימָה:
export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אישור | Auth | מופע ה- Auth . |
קוד | חוּט | קוד אימות שנשלח למשתמש. |
החזרות:
הבטחה<string>
כתובת האימייל של המשתמש אם תקפה.
פונקציה (קישור, ...)
parseActionCodeURL(קישור)
מנתח את מחרוזת הקישור לפעולת הדוא"ל ומחזירה ActionCodeURL אם הקישור חוקי, אחרת מחזירה null.
חֲתִימָה:
export declare function parseActionCodeURL(link: string): ActionCodeURL | null;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
קישור | חוּט |
החזרות:
ActionCodeURL | ריק
פונקציה (משתמש, ...)
מחקUser(משתמש)
מוחק ומוציא את המשתמש.
חֲתִימָה:
export declare function deleteUser(user: User): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
החזרות:
הבטחה<void>
getIdToken(משתמש, forceRefresh)
מחזירה JSON Web Token (JWT) המשמש לזיהוי המשתמש לשירות Firebase.
מחזירה את האסימון הנוכחי אם לא פג תוקפו או אם לא יפוג בחמש הדקות הבאות. אחרת, זה ירענן את האסימון ויחזיר אחד חדש.
חֲתִימָה:
export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
כוחRefresh | בוליאני | כפה רענון ללא קשר לפקיעת האסימון. |
החזרות:
הבטחה<string>
getIdTokenResult(משתמש, forceRefresh)
מחזירה JSON Web Token (JWT) המשמש לזיהוי המשתמש לשירות Firebase.
מחזירה את האסימון הנוכחי אם לא פג תוקפו או אם לא יפוג בחמש הדקות הבאות. אחרת, זה ירענן את האסימון ויחזיר אחד חדש.
חֲתִימָה:
export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
כוחRefresh | בוליאני | כפה רענון ללא קשר לפקיעת האסימון. |
החזרות:
הבטחה< IdTokenResult >
linkWithCredential(משתמש, אישור)
מקשר את חשבון המשתמש עם האישורים שניתנו.
ניתן להשתמש ב- AuthProvider כדי ליצור את האישור.
חֲתִימָה:
export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
תְעוּדָה | AuthCredential | האישור. |
החזרות:
הבטחה< UserCredential >
linkWithPhoneNumber(משתמש, phoneNumber, appVerifier)
מקשר את חשבון המשתמש עם מספר הטלפון הנתון.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
מספר טלפון | חוּט | מספר הטלפון של המשתמש בפורמט E.164 (לדוגמה +165055550101). |
appVerifier | ApplicationVerifier | ApplicationVerifier . |
החזרות:
הבטחה< ConfirmationResult >
linkWithPopup(משתמש, ספק, פותר)
מקשר את הספק המאומת לחשבון המשתמש באמצעות זרימת OAuth מבוססת קופץ.
אם הקישור יצליח, התוצאה המוחזרת תכיל את המשתמש ואת האישורים של הספק.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
ספק | AuthProvider | הספק לאימות. הספק חייב להיות OAuthProvider . ספקים שאינם OAuth כמו EmailAuthProvider יזרוק שגיאה. |
פותר | PopupRedirectResolver | מופע של PopupRedirectResolver , אופציונלי אם כבר מסופק ל- initializeAuth() או מסופק על-ידי getAuth() . |
החזרות:
הבטחה< UserCredential >
דוגמא
// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);
linkWithRedirect(משתמש, ספק, פותר)
מקשר את ה- OAuthProvider לחשבון המשתמש באמצעות זרימת הפניה מחדש של עמוד שלם.
כדי לטפל בתוצאות והשגיאות לפעולה זו, עיין ב- GetRedIrectresult () . עקוב אחר שיטות העבודה המומלצות בעת השימוש ב- LinkWithRedIrect () .
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
ספק | AuthProvider | הספק לאמת. הספק צריך להיות Oauthprovider . ספקי שאינם Oauuth כמו ImagauthProvider יזרקו שגיאה. |
Resolver | Popupredirectresolver | מופע של Popupredirectresolver , אופציונלי אם כבר מסופק ל- Incumentizeauth () או מסופק על ידי Getauth () . |
החזרות:
הבטחה <nerver>
דוגמא
// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app
// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
רב -פקטור (משתמש)
ה- MultiFactoruser המתאים למשתמש.
זה משמש לגישה לכל המאפיינים והפעולות הרב-גורמים הקשורים למשתמש.
חֲתִימָה:
export declare function multiFactor(user: User): MultiFactorUser;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
החזרות:
reuthenticatewithCredential (משתמש, תעודה)
מאמת מחדש משתמש המשתמש בתעודה טרייה.
השתמש לפני פעולות כגון UpdatePassword () הדורש אסימונים מניסיונות הכניסה האחרונים. ניתן להשתמש בשיטה זו כדי להתאושש משגיאת CREDENTIAL_TOO_OLD_LOGIN_AGAIN
או שגיאה TOKEN_EXPIRED
.
חֲתִימָה:
export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
תְעוּדָה | Authcredential | אישור המחבר. |
החזרות:
הבטחה < userCredential >
reuthenticatewithponenumber (משתמש, phonenumber, appverifier)
מאמת מחדש משתמש המשתמש בתעודת טלפון טרייה.
השתמש לפני פעולות כגון UpdatePassword () הדורש אסימונים מניסיונות הכניסה האחרונים.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
מספר טלפון | חוּט | מספר הטלפון של המשתמש בפורמט E.164 (למשל +16505550101). |
Appverifier | ApplicationVerifier | ה- ApplicationVerifier . |
החזרות:
הבטחה < EntricationResult >
reuthenticatewithpopup (משתמש, ספק, Resolver)
מציג מחדש את המשתמש הנוכחי עם ה- OAuthProvider שצוין באמצעות זרימת OAuth מבוססת קופץ.
אם ההגנה מחדש תצליח, התוצאה המוחזרת תכיל את המשתמש ואת תעודת הספק.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
ספק | AuthProvider | הספק לאמת. הספק צריך להיות Oauthprovider . ספקי שאינם Oauuth כמו ImagauthProvider יזרקו שגיאה. |
Resolver | Popupredirectresolver | מופע של Popupredirectresolver , אופציונלי אם כבר מסופק ל- Incumentizeauth () או מסופק על ידי Getauth () . |
החזרות:
הבטחה < userCredential >
דוגמא
// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);
reuthenticatewithredirect (משתמש, ספק, Resolver)
מציג מחדש את המשתמש הנוכחי עם ה- OAuthProvider שצוין באמצעות זרימת הפניה מחדש בעמוד מלא.
כדי לטפל בתוצאות והשגיאות לפעולה זו, עיין ב- GetRedIrectresult () . עקוב אחר שיטות העבודה המומלצות בעת שימוש ReuthentIcteDwithRect () .
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
ספק | AuthProvider | הספק לאמת. הספק צריך להיות Oauthprovider . ספקי שאינם Oauuth כמו ImagauthProvider יזרקו שגיאה. |
Resolver | Popupredirectresolver | מופע של Popupredirectresolver , אופציונלי אם כבר מסופק ל- Incumentizeauth () או מסופק על ידי Getauth () . |
החזרות:
הבטחה <nerver>
דוגמא
// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app
// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app
// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
טען מחדש (משתמש)
טוען מחדש נתוני חשבון משתמש, אם נחתם.
חֲתִימָה:
export declare function reload(user: User): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
החזרות:
הבטחה <void>
SendeMailverification (משתמש, ActionCodesettings)
שולח דוא"ל אימות למשתמש.
תהליך האימות הושלם על ידי התקשרות ל- ApplayCode () .
חֲתִימָה:
export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
ActionCodesettings | ActionCodesettings | ריק | ה- ActionCodesettings . |
החזרות:
הבטחה <void>
דוגמא
const actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);
UNLLINK (משתמש, PREVIDERID)
מנתק קישור ספק מחשבון משתמש.
חֲתִימָה:
export declare function unlink(user: User, providerId: string): Promise<User>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
Providerid | חוּט | הספק לביטול קישור. |
החזרות:
מבטיח < משתמש >
updateemail (משתמש, newemail)
מעדכן את כתובת הדוא"ל של המשתמש.
דוא"ל יישלח לכתובת הדוא"ל המקורית (אם הוא נקבע) המאפשר לבטל את שינוי כתובת הדוא"ל, על מנת להגן עליהם מפני חטיפת חשבונות.
חֲתִימָה:
export declare function updateEmail(user: User, newEmail: string): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
מייל חדש | חוּט | כתובת הדוא"ל החדשה. שגיאה "Auth/Operation-Not-Enained" כאשר [הגנת דוא"ל להגנת דואר] (https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) מופעלת. במקום זאת, השתמש ב- VERIFYBEFOREUPDATEEMAIL () במקום זאת. |
החזרות:
הבטחה <void>
UpdatePassword (משתמש, NewPassword)
מעדכן את סיסמת המשתמש.
חֲתִימָה:
export declare function updatePassword(user: User, newPassword: string): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
סיסמה חדשה | חוּט | הסיסמה החדשה. |
החזרות:
הבטחה <void>
UpdatePhoneNumber (משתמש, תעודה)
מעדכן את מספר הטלפון של המשתמש.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
תְעוּדָה | Phoneauthredential | אישור המאמת את מספר הטלפון החדש. |
החזרות:
הבטחה <void>
דוגמא
// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);
UpdateProfile (משתמש, {DisplayName, Photourl: Photourl})
מעדכן את נתוני הפרופיל של המשתמש.
חֲתִימָה:
export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
displayName?: string | null;
photoURL?: string | null;
}): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
{DisplayName, Photourl: Photourl} | {DisplayName?: מחרוזת | ריק; פוטורל?: מחרוזת | ריק; } |
החזרות:
הבטחה <void>
VERIFEBEFOREUPDATEEMAIL (משתמש, NEWEMAIL, ActionCodesettings)
שולח דוא"ל אימות לכתובת דוא"ל חדשה.
דוא"ל המשתמש יעודכן לחדש לאחר אימות.
אם יש לך מטפל בהתאמה אישית של פעולות דוא"ל, אתה יכול להשלים את תהליך האימות על ידי התקשרות ל- ApplayCationCode () .
חֲתִימָה:
export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
מִשׁתַמֵשׁ | מִשׁתַמֵשׁ | המשתמש. |
מייל חדש | חוּט | כתובת הדוא"ל החדשה שתאמת לפני העדכון. |
ActionCodesettings | ActionCodesettings | ריק | ה- ActionCodesettings . |
החזרות:
הבטחה <void>
דוגמא
const actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);
פונקציה (UserCredential, ...)
getAdditionaluserInfo (userCredential)
מחלץ ספק ספציפי SpecifyOserInfo עבור האישור הנתון.
חֲתִימָה:
export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
userCredential | UserCredential | תעודת המשתמש. |
החזרות:
נוסף userinfo | ריק
ActionCodeOperation
ספירה של סוגי הפעולות האפשריות.
חֲתִימָה:
ActionCodeOperation: {
readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
readonly PASSWORD_RESET: "PASSWORD_RESET";
readonly RECOVER_EMAIL: "RECOVER_EMAIL";
readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}
Autherrorcodes
מפה של קודי שגיאה של Auth
פוטנציאליים, לשם השוואה קלה יותר עם שגיאות שנזרקו על ידי ה- SDK.
שימו לב שאינכם יכולים למפתחות בודדים לשיחת עץ במפה, ולכן באמצעות השימוש במפה תוכלו להגדיל באופן משמעותי את גודל הצרור שלכם.
חֲתִימָה:
AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
readonly ARGUMENT_ERROR: "auth/argument-error";
readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
readonly APP_NOT_INSTALLED: "auth/app-not-installed";
readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
readonly CODE_EXPIRED: "auth/code-expired";
readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
readonly EMAIL_EXISTS: "auth/email-already-in-use";
readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
readonly INTERNAL_ERROR: "auth/internal-error";
readonly INVALID_API_KEY: "auth/invalid-api-key";
readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
readonly INVALID_APP_ID: "auth/invalid-app-id";
readonly INVALID_AUTH: "auth/invalid-user-token";
readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
readonly INVALID_CODE: "auth/invalid-verification-code";
readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
readonly INVALID_EMAIL: "auth/invalid-email";
readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
readonly INVALID_OOB_CODE: "auth/invalid-action-code";
readonly INVALID_ORIGIN: "auth/unauthorized-domain";
readonly INVALID_PASSWORD: "auth/wrong-password";
readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
readonly INVALID_SENDER: "auth/invalid-sender";
readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
readonly MISSING_CODE: "auth/missing-verification-code";
readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
readonly MODULE_DESTROYED: "auth/app-deleted";
readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
readonly NULL_USER: "auth/null-user";
readonly NO_AUTH_EVENT: "auth/no-auth-event";
readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
readonly POPUP_BLOCKED: "auth/popup-blocked";
readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
readonly TIMEOUT: "auth/timeout";
readonly TOKEN_EXPIRED: "auth/user-token-expired";
readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
readonly UNVERIFIED_EMAIL: "auth/unverified-email";
readonly USER_CANCELLED: "auth/user-cancelled";
readonly USER_DELETED: "auth/user-not-found";
readonly USER_DISABLED: "auth/user-disabled";
readonly USER_MISMATCH: "auth/user-mismatch";
readonly USER_SIGNED_OUT: "auth/user-signed-out";
readonly WEAK_PASSWORD: "auth/weak-password";
readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
readonly ALREADY_INITIALIZED: "auth/already-initialized";
readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}
Browserlocalpersistence
יישום התמדה של סוג LOCAL
באמצעות localStorage
לצורך האחסון הבסיסי.
חֲתִימָה:
browserLocalPersistence: Persistence
BrowserPopupRedirectresolver
יישום של PopuPredirectresolver המתאים ליישומים מבוססי דפדפן.
שיטה זו אינה פועלת בסביבת Node.js.
חֲתִימָה:
browserPopupRedirectResolver: PopupRedirectResolver
התנגדות לדפדפנות
יישום התמדה של הפעלה SESSION
sessionStorage
לצורך האחסון הבסיסי.
חֲתִימָה:
browserSessionPersistence: Persistence
CORDOVAPOPUPREDIRECTRESOLVER
יישום של Popupredirectresolver המתאים ליישומים מבוססי קורדובה.
חֲתִימָה:
cordovaPopupRedirectResolver: PopupRedirectResolver
DebugerRormap
מפת שגיאות מילולית עם תיאורים מפורטים עבור מרבית קודי השגיאה.
ראו דיון ב- AutherRormap
חֲתִימָה:
debugErrorMap: AuthErrorMap
גורם
אגן של גורמים שעשויים לשמש לאימות רב -פקטורי.
חֲתִימָה:
FactorId: {
readonly PHONE: "phone";
readonly TOTP: "totp";
}
indexedddblocalpersistence
יישום התמדה של סוג LOCAL
באמצעות indexedDB
לאחסון הבסיסי.
חֲתִימָה:
indexedDBLocalPersistence: Persistence
inmemoryPersectence
יישום התמדה מסוג 'אין'.
חֲתִימָה:
inMemoryPersistence: Persistence
OperationType
ספירה של סוגי פעולה נתמכים.
חֲתִימָה:
OperationType: {
readonly LINK: "link";
readonly REAUTHENTICATE: "reauthenticate";
readonly SIGN_IN: "signIn";
}
proderromap
מפת שגיאות מינימלית עם כל הודעות השגיאה המילוליות שהופשטו.
ראו דיון ב- AutherRormap
חֲתִימָה:
prodErrorMap: AuthErrorMap
Providerid
ספירה של ספקים נתמכים.
חֲתִימָה:
ProviderId: {
readonly FACEBOOK: "facebook.com";
readonly GITHUB: "github.com";
readonly GOOGLE: "google.com";
readonly PASSWORD: "password";
readonly PHONE: "phone";
readonly TWITTER: "twitter.com";
}
Signinmethod
ספירה של שיטות כניסה נתמכות.
חֲתִימָה:
SignInMethod: {
readonly EMAIL_LINK: "emailLink";
readonly EMAIL_PASSWORD: "password";
readonly FACEBOOK: "facebook.com";
readonly GITHUB: "github.com";
readonly GOOGLE: "google.com";
readonly PHONE: "phone";
readonly TWITTER: "twitter.com";
}
CustomParameters
מפה של פרמטרים מותאמים אישית של OAuth.
חֲתִימָה:
export declare type CustomParameters = Record<string, string>;
NextOroBserver
הגדרת הקלד לקבלת התקשרות לאירוע.
חֲתִימָה:
export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
Phoneinfooptions
המידע הנדרש כדי לאמת את הבעלות על מספר טלפון.
המידע הנדרש תלוי בשאלה אם אתה מבצע כניסה יחידה של גורם יחיד, הרשמה רב-גורמית או כניסה מרובת גורמים.
חֲתִימָה:
export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;
פרופיל משתמש
פרופיל המשתמש המשמש ב- ExtranserInfo .
חֲתִימָה:
export declare type UserProfile = Record<string, unknown>;