BaseAuth class

ממשק אב משותף עבור ממשקי API של Auth ו- TenantAwareAuth .

חֲתִימָה:

export declare abstract class BaseAuth

שיטות

שיטה משנה תיאור
createCustomToken(uid, developerClaims) יוצר אסימון מותאם אישית חדש של Firebase (JWT) שניתן לשלוח בחזרה למכשיר לקוח כדי להשתמש בו כדי להיכנס עם שיטות signInWithCustomToken() של ערכות SDK של הלקוח. (מקרים מודעים לדיירים יטמיעו גם את מזהה הדייר באסימון.) ראה יצירת אסימונים מותאמים אישית לדוגמאות קוד ותיעוד מפורט.
createProviderConfig(config) מחזירה הבטחה שנפתרת עם AuthProviderConfig החדש שנוצר כאשר נוצרת תצורת הספק החדשה. תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
createSessionCookie(idToken, sessionCookieOptions) יוצר קובץ Cookie חדש להפעלה של Firebase עם האפשרויות שצוינו. ניתן להגדיר את מחרוזת ה-JWT שנוצרה כ-Cookie של הפעלה בצד השרת עם מדיניות קובצי Cookie מותאמת אישית, ולשמש לניהול הפעלה. לעוגיית ההפעלה JWT יהיו אותן תביעות מטען כמו אסימון הזיהוי שסופק. ראה ניהול קובצי Cookie של הפעלה לדוגמאות קוד ותיעוד מפורט.
createUser(מאפיינים) יוצר משתמש חדש. ראה יצירת משתמש לדוגמאות קוד ותיעוד מפורט.
deleteProviderConfig(providerId) מוחק את תצורת הספק התואמת למזהה הספק שעבר. אם המזהה שצוין לא קיים, נגרמת שגיאת auth/configuration-not-found . תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
deleteUser(uid) מוחק משתמש קיים. ראה מחיקת משתמש לדוגמאות קוד ותיעוד מפורט.
deleteUsers(uids) מוחק את המשתמשים שצוינו ב-uids הנתונים. מחיקת משתמש לא קיים לא תיצור שגיאה (כלומר שיטה זו היא אימפוטנטית). משתמשים לא קיימים נחשבים למחיקה מוצלחת, ולכן נספרים בערך DeleteUsersResult.successCount . ניתן לספק לכל היותר 1000 מזהים. אם מסופקים יותר מ-1000 מזהים, שיטה זו זורקת FirebaseAuthError. ממשק API זה מוגבל כרגע בשרת ל-1 QPS. אם תחרוג מזה, ייתכן שתקבל שגיאת חריגה מהמכסה. לכן, אם ברצונך למחוק יותר מ-1000 משתמשים, ייתכן שיהיה עליך להוסיף עיכוב כדי להבטיח שלא תחרוג מהמגבלה הזו.
generEmailVerificationLink(אימייל, actionCodeSettings) יוצר את הקישור לפעולת דוא"ל מחוץ לתחום כדי לאמת את בעלות המשתמש על האימייל שצוין. האובייקט ActionCodeSettings שסופק כארגומנט לשיטה זו מגדיר האם הקישור יטופל על ידי אפליקציה לנייד או דפדפן יחד עם מידע מצב נוסף שיועבר בקישור העמוק וכו'.
generPasswordResetLink(אימייל, actionCodeSettings) יוצר את קישור פעולת הדוא"ל מחוץ לרצועה כדי לאפס סיסמה של משתמש. הקישור נוצר עבור המשתמש עם כתובת האימייל שצוינה. האובייקט האופציונלי ActionCodeSettings מגדיר אם הקישור יטופל על ידי אפליקציה או דפדפן נייד ואת פרטי המצב הנוסף שיועבר בקישור העמוק וכו'.
generSignInWithEmailLink(אימייל, actionCodeSettings) יוצר את הקישור לפעולת דוא"ל מחוץ לתחום כדי לאמת את בעלות המשתמש על האימייל שצוין. האובייקט ActionCodeSettings שסופק כארגומנט לשיטה זו מגדיר האם הקישור יטופל על ידי אפליקציה לנייד או דפדפן יחד עם מידע מצב נוסף שיועבר בקישור העמוק וכו'.
generVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) יוצר קישור לפעולת דוא"ל מחוץ לתחום כדי לאמת את בעלות המשתמש על האימייל שצוין. האובייקט ActionCodeSettings שסופק כארגומנט לשיטה זו מגדיר האם הקישור יטופל על ידי אפליקציה לנייד או דפדפן יחד עם מידע מצב נוסף שיועבר בקישור העמוק וכו'.
getProviderConfig(providerId) מחפש תצורת ספק Auth לפי המזהה שסופק. מחזירה הבטחה שנפתרת עם תצורת הספק התואמת למזהה הספק שצוין. אם המזהה שצוין לא קיים, נגרמת שגיאת auth/configuration-not-found . תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
getUser(uid) מקבל את נתוני המשתמש עבור המשתמש התואמים ל- uid נתון. ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.
getUserByEmail(email) מקבל את נתוני המשתמש עבור המשתמש התואמים לאימייל נתון. ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.
getUserByPhoneNumber(phoneNumber) מקבל את נתוני המשתמש עבור המשתמש התואמים למספר טלפון נתון. מספר הטלפון צריך להתאים למפרט E.164. ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.
getUserByProviderUid(providerId, uid) מקבל את נתוני המשתמש עבור המשתמש התואמים למזהה ספק נתון. ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.
getUsers(מזהים) מקבל את נתוני המשתמש התואמים למזהים שצוינו. אין ערבויות הזמנה; בפרט, לא מובטח שהערך ה-n ברשימת התוצאות תואם לערך ה-n ברשימת פרמטרי הקלט. ניתן לספק עד 100 מזהים לכל היותר. אם מסופקים יותר מ-100 מזהים, שיטה זו זורקת FirebaseAuthError.
importUsers(משתמשים, אפשרויות) מייבא את רשימת המשתמשים שסופקה ל-Firebase Auth. מותר לייבא עד 1000 משתמשים אחד בכל פעם. בעת ייבוא ​​משתמשים עם סיסמאות, יש לציין את UserImportOptions . פעולה זו מותאמת לייבוא ​​בכמות גדולה ותתעלם מבדיקות של uid , email וייחודיות מזהה אחרת שעלולה לגרום לכפילויות.
listProviderConfigs(אפשרויות) מחזירה את רשימת תצורות הספקים הקיימות התואמות למסנן שסופק. לכל היותר, ניתן לרשום 100 תצורות ספק בכל פעם. תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
listUsers(maxResults, pageToken) מאחזר רשימה של משתמשים (אצווה בודדת בלבד) עם גודל של maxResults החל מההיסט כפי שצוין ב- pageToken . זה משמש כדי לאחזר את כל המשתמשים של פרויקט מוגדר באצווה. ראה רשימת כל המשתמשים לקבלת דוגמאות קוד ותיעוד מפורט.
revokeRefreshTokens(uid) מבטל את כל אסימוני הרענון עבור משתמש קיים. ממשק API זה יעדכן את UserRecord.tokensValidAfterTime של המשתמש ל-UTC הנוכחי. חשוב שהשעון שלו מכוון נכון ומסונכרן לשרת שבו זה נקרא. אמנם זה יבטל את כל ההפעלות עבור משתמש מסוים ותשבית את ההטבעה של כל אסימוני מזהה חדשים עבור הפעלות קיימות, אך אסימוני מזהה קיימים עשויים להישאר פעילים עד לפקיעת התפוגה הטבעית שלהם (שעה אחת). כדי לוודא שאסימוני מזהה בוטלו, השתמש ב-BaseAuth.verifyIdToken() כאשר checkRevoked מוגדר כ-true.
setCustomUserClaims(uid, customUserClaims) מגדיר תביעות מפתח נוספות על משתמש קיים המזוהה על ידי uid שסופק, המשמש בדרך כלל להגדרת תפקידי משתמש ורמות גישה. הטענות הללו צריכות להתפשט לכל המכשירים שבהם המשתמש כבר מחובר (לאחר פקיעת תוקף האסימון או כאשר רענון האסימון נאלץ) ובפעם הבאה שהמשתמש ייכנס. אם נעשה שימוש בשם תביעה שמור של OIDC (תת, iat, iss וכו' ), נזרקת שגיאה. הם מוגדרים על אסימון הזיהוי של המשתמש המאומת JWT. ראה הגדרת תפקידי משתמש ורמות גישה לדוגמאות קוד ותיעוד מפורט.
updateProviderConfig(providerId, updatedConfig) מחזירה הבטחה שנפתרת עם AuthProviderConfig המעודכן התואם למזהה הספק שצוין. אם המזהה שצוין לא קיים, נגרמת שגיאת auth/configuration-not-found . תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
updateUser(uid, properties) מעדכן משתמש קיים. ראה עדכון משתמש לקבלת דוגמאות קוד ותיעוד מפורט.
verifyIdToken(idToken, checkRevoked) מאמת אסימון מזהה Firebase (JWT). אם האסימון תקף, ההבטחה מתקיימת עם הטענות המפוענחות של האסימון; אחרת, ההבטחה נדחית. אם checkRevoked מוגדר כ-true, תחילה מוודא אם המשתמש המתאים מושבת. אם כן, נגרמת שגיאת auth/user-disabled . אם לא, מאמת אם ההפעלה התואמת לאסימון המזהה בוטלה. אם הפגישה של המשתמש התואמת לא הייתה חוקית, נגרמת שגיאת auth/id-token-revoked . אם לא צוין ההמחאה לא מוחלת. ראה אימות אסימוני מזהה לדוגמאות קוד ותיעוד מפורט.
verifySessionCookie(sessionCookie, checkRevoked) מאמת קובץ Cookie של הפעלה של Firebase. מחזיר הבטחה עם טענות העוגיות. דוחה את ההבטחה אם לא ניתן לאמת את העוגייה. אם checkRevoked מוגדר כ-true, תחילה מוודא אם המשתמש המתאים מושבת: אם כן, נגרמת שגיאת auth/user-disabled . אם לא, מאמת אם ההפעלה התואמת לקובץ ה-cookie של ההפעלה בוטלה. אם ההפעלה של המשתמש התואמת לא בוטלה, נגרמת שגיאה auth/session-cookie-revoked . אם לא צוין הבדיקה לא מבוצעת. ראה אימות קובצי Cookie של הפעלה לדוגמאות קוד ותיעוד מפורט

BaseAuth.createCustomToken()

יוצר אסימון מותאם אישית חדש של Firebase (JWT) שניתן לשלוח בחזרה למכשיר לקוח כדי להשתמש בו כדי להיכנס עם שיטות signInWithCustomToken() של ערכות SDK של הלקוח. (מקרים מודעים לדיירים יטמיעו גם את מזהה הדייר באסימון.)

ראה יצירת אסימונים מותאמים אישית לדוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uid חוּט ה- uid לשימוש כנושא האסימון המותאם אישית.
תביעות מפתח לְהִתְנַגֵד תביעות נוספות אופציונליות לכלול במטען המותאם של האסימון המותאם אישית.

החזרות:

הבטחה<string>

הבטחה שמומשה עם אסימון מותאם אישית עבור uid והמטען שסופק.

BaseAuth.createProviderConfig()

מחזירה הבטחה שנפתרת עם AuthProviderConfig החדש שנוצר כאשר נוצרת תצורת הספק החדשה.

תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .

חֲתִימָה:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
תצורה AuthProviderConfig תצורת הספק שיש ליצור.

החזרות:

הבטחה< AuthProviderConfig >

הבטחה שנפתרת עם תצורת הספק שנוצרה.

BaseAuth.createSessionCookie()

יוצר קובץ Cookie חדש להפעלה של Firebase עם האפשרויות שצוינו. ניתן להגדיר את מחרוזת ה-JWT שנוצרה כ-Cookie של הפעלה בצד השרת עם מדיניות קובצי Cookie מותאמת אישית, ולשמש לניהול הפעלה. לעוגיית ההפעלה JWT יהיו אותן תביעות מטען כמו אסימון הזיהוי שסופק.

ראה ניהול קובצי Cookie של הפעלה לדוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
idToken חוּט אסימון ה-Firebase ID להחלפה בקובץ cookie של הפעלה.
sessionCookieOptions SessionCookieOptions אפשרויות ה-cookie של ההפעלה הכוללות משך הפעלה מותאם אישית.

החזרות:

הבטחה<string>

הבטחה שפותרת הצלחה עם עוגיית ההפעלה שנוצרה.

BaseAuth.createUser()

יוצר משתמש חדש.

ראה יצירת משתמש לדוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

createUser(properties: CreateRequest): Promise<UserRecord>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
נכסים CreateRequest המאפיינים שיש להגדיר ברשומת המשתמש החדשה שתיווצר.

החזרות:

הבטחה< UserRecord >

הבטחה מקוימה עם נתוני המשתמש התואמים למשתמש החדש שנוצר.

BaseAuth.deleteProviderConfig()

מוחק את תצורת הספק התואמת למזהה הספק שעבר. אם המזהה שצוין לא קיים, נגרמת שגיאת auth/configuration-not-found .

תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .

חֲתִימָה:

deleteProviderConfig(providerId: string): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
providerId חוּט מזהה הספק המתאים לתצורת הספק שיש למחוק.

החזרות:

הבטחה<void>

הבטחה שנפתרת עם השלמתה.

BaseAuth.deleteUser()

מוחק משתמש קיים.

ראה מחיקת משתמש לדוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

deleteUser(uid: string): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uid חוּט ה- uid המתאים למשתמש שיש למחוק.

החזרות:

הבטחה<void>

הבטחה ריקה ממומשת לאחר מחיקת המשתמש.

BaseAuth.deleteUsers()

מוחק את המשתמשים שצוינו ב-uids הנתונים.

מחיקת משתמש לא קיים לא תיצור שגיאה (כלומר שיטה זו היא אימפוטנטית). משתמשים לא קיימים נחשבים למחיקה מוצלחת, ולכן נספרים בערך DeleteUsersResult.successCount .

ניתן לספק לכל היותר 1000 מזהים. אם מסופקים יותר מ-1000 מזהים, שיטה זו זורקת FirebaseAuthError.

ממשק API זה מוגבל כרגע בשרת ל-1 QPS. אם תחרוג מזה, ייתכן שתקבל שגיאת חריגה מהמכסה. לכן, אם ברצונך למחוק יותר מ-1000 משתמשים, ייתכן שיהיה עליך להוסיף עיכוב כדי להבטיח שלא תחרוג מהמגבלה הזו.

חֲתִימָה:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uids חוּט[] ה- uids המתאימים למשתמשים שיש למחוק.

החזרות:

הבטחה< DeleteUsersResult >

הבטחה שפותרת את המספר הכולל של מחיקות מוצלחות/נכשלות, כמו גם מערך השגיאות המתאים למחיקות שנכשלו.

יוצר את הקישור לפעולת דוא"ל מחוץ לתחום כדי לאמת את בעלות המשתמש על האימייל שצוין. האובייקט ActionCodeSettings שסופק כארגומנט לשיטה זו מגדיר האם הקישור יטופל על ידי אפליקציה לנייד או דפדפן יחד עם מידע מצב נוסף שיועבר בקישור העמוק וכו'.

חֲתִימָה:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אימייל חוּט חשבון האימייל לאימות.
actionCodeSettings ActionCodeSettings הגדרות קוד הפעולה. אם צוין, כתובת האתר/ההמשך מוגדרת כפרמטר "continueUrl" בקישור לאימות האימייל. דף הנחיתה של ברירת המחדל לאימות דוא"ל ישתמש בזה כדי להציג קישור לחזרה לאפליקציה אם היא מותקנת. אם ה-actionCodeSettings לא צוין, לא מצורף כתובת URL לכתובת ה-URL של הפעולה. כתובת האתר של המדינה שסופקה חייבת להיות שייכת לדומיין שנמצא ברשימת ההיתרים של המפתח במסוף. אחרת נזרקת שגיאה. הפניות מחדש של אפליקציות לנייד ישימות רק אם המפתח מגדיר ומקבל את התנאים וההגבלות של Firebase Dynamic Links. שם החבילה של Android ומזהה החבילה של iOS מכבדים רק אם הם מוגדרים באותו פרויקט Firebase Auth.

החזרות:

הבטחה<string>

הבטחה שנפתרת עם הקישור שנוצר.

דוגמא

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

יוצר את קישור פעולת הדוא"ל מחוץ לרצועה כדי לאפס סיסמה של משתמש. הקישור נוצר עבור המשתמש עם כתובת האימייל שצוינה. האובייקט האופציונלי ActionCodeSettings מגדיר אם הקישור יטופל על ידי אפליקציה או דפדפן נייד ואת פרטי המצב הנוסף שיועבר בקישור העמוק וכו'.

חֲתִימָה:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אימייל חוּט כתובת הדואר האלקטרוני של המשתמש שאת הסיסמה שלו יש לאפס.
actionCodeSettings ActionCodeSettings הגדרות קוד הפעולה. אם צוין, כתובת האתר/ההמשך מוגדרת כפרמטר "continueUrl" בקישור לאיפוס הסיסמה. דף הנחיתה של ברירת המחדל לאיפוס הסיסמה ישתמש בכך כדי להציג קישור לחזרה לאפליקציה אם היא מותקנת. אם ה-actionCodeSettings לא צוין, לא מצורף כתובת URL לכתובת ה-URL של הפעולה. כתובת האתר של המדינה שסופקה חייבת להיות שייכת לדומיין שנמצא ברשימת ההיתרים של המפתח במסוף. אחרת נזרקת שגיאה. הפניות מחדש של אפליקציות לנייד ישימות רק אם המפתח מגדיר ומקבל את התנאים וההגבלות של Firebase Dynamic Links. שם החבילה של Android ומזהה החבילה של iOS מכבדים רק אם הם מוגדרים באותו פרויקט Firebase Auth.

החזרות:

הבטחה<string>

הבטחה שנפתרת עם הקישור שנוצר.

דוגמא

var 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,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

יוצר את הקישור לפעולת דוא"ל מחוץ לתחום כדי לאמת את בעלות המשתמש על האימייל שצוין. האובייקט ActionCodeSettings שסופק כארגומנט לשיטה זו מגדיר האם הקישור יטופל על ידי אפליקציה לנייד או דפדפן יחד עם מידע מצב נוסף שיועבר בקישור העמוק וכו'.

חֲתִימָה:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אימייל חוּט חשבון האימייל לאימות.
actionCodeSettings ActionCodeSettings הגדרות קוד הפעולה. אם צוין, כתובת האתר/ההמשך מוגדרת כפרמטר "continueUrl" בקישור לאימות האימייל. דף הנחיתה של ברירת המחדל לאימות דוא"ל ישתמש בזה כדי להציג קישור לחזרה לאפליקציה אם היא מותקנת. אם ה-actionCodeSettings לא צוין, לא מצורף כתובת URL לכתובת ה-URL של הפעולה. כתובת האתר של המדינה שסופקה חייבת להיות שייכת לדומיין שנמצא ברשימת ההיתרים של המפתח במסוף. אחרת נזרקת שגיאה. הפניות מחדש של אפליקציות לנייד ישימות רק אם המפתח מגדיר ומקבל את התנאים וההגבלות של Firebase Dynamic Links. שם החבילה של Android ומזהה החבילה של iOS מכבדים רק אם הם מוגדרים באותו פרויקט Firebase Auth.

החזרות:

הבטחה<string>

הבטחה שנפתרת עם הקישור שנוצר.

דוגמא

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

יוצר קישור לפעולת דוא"ל מחוץ לתחום כדי לאמת את בעלות המשתמש על האימייל שצוין. האובייקט ActionCodeSettings שסופק כארגומנט לשיטה זו מגדיר האם הקישור יטופל על ידי אפליקציה לנייד או דפדפן יחד עם מידע מצב נוסף שיועבר בקישור העמוק וכו'.

חֲתִימָה:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אימייל חוּט חשבון האימייל הנוכחי.
מייל חדש חוּט כתובת האימייל שאליה החשבון מתעדכן.
actionCodeSettings ActionCodeSettings הגדרות קוד הפעולה. אם צוין, כתובת האתר/ההמשך מוגדרת כפרמטר "continueUrl" בקישור לאימות האימייל. דף הנחיתה של ברירת המחדל לאימות דוא"ל ישתמש בזה כדי להציג קישור לחזרה לאפליקציה אם היא מותקנת. אם ה-actionCodeSettings לא צוין, לא מצורף כתובת URL לכתובת ה-URL של הפעולה. כתובת ה-URL של המדינה שסופקה חייבת להיות שייכת לדומיין מורשה במסוף, אחרת תיגרם שגיאה. הפניות מחדש של אפליקציות לנייד ישימות רק אם המפתח מגדיר ומקבל את התנאים וההגבלות של Firebase Dynamic Links. שם החבילה של Android ומזהה החבילה של iOS מכבדים רק אם הם מוגדרים באותו פרויקט Firebase Auth.

החזרות:

הבטחה<string>

הבטחה שנפתרת עם הקישור שנוצר.

BaseAuth.getProviderConfig()

מחפש תצורת ספק Auth לפי המזהה שסופק. מחזירה הבטחה שנפתרת עם תצורת הספק התואמת למזהה הספק שצוין. אם המזהה שצוין לא קיים, נגרמת שגיאת auth/configuration-not-found .

תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .

חֲתִימָה:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
providerId חוּט מזהה הספק המתאים לתצורת הספק להחזיר.

החזרות:

הבטחה< AuthProviderConfig >

הבטחה שנפתרת עם התצורה המתאימה למזהה שסופק.

BaseAuth.getUser()

מקבל את נתוני המשתמש עבור המשתמש התואמים ל- uid נתון .

ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

getUser(uid: string): Promise<UserRecord>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uid חוּט ה- uid המתאים למשתמש שאת הנתונים שלו יש לאחזר.

החזרות:

הבטחה< UserRecord >

הבטחה שמומשה עם נתוני המשתמש התואמים ל- uid שסופק .

BaseAuth.getUserByEmail()

מקבל את נתוני המשתמש עבור המשתמש התואמים לאימייל נתון.

ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

getUserByEmail(email: string): Promise<UserRecord>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אימייל חוּט האימייל המתאים למשתמש שאת הנתונים שלו יש לאחזר.

החזרות:

הבטחה< UserRecord >

הבטחה מקוימה עם נתוני המשתמש התואמים לאימייל שסופק.

BaseAuth.getUserByPhoneNumber()

מקבל את נתוני המשתמש עבור המשתמש התואמים למספר טלפון נתון. מספר הטלפון צריך להתאים למפרט E.164.

ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מספר טלפון חוּט מספר הטלפון המתאים למשתמש שאת הנתונים שלו יש להביא.

החזרות:

הבטחה< UserRecord >

הבטחה מקוימה עם נתוני המשתמש התואמים למספר הטלפון שסופק.

BaseAuth.getUserByProviderUid()

מקבל את נתוני המשתמש עבור המשתמש התואמים למזהה ספק נתון.

ראה אחזור נתוני משתמש לקבלת דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
providerId חוּט מזהה הספק, לדוגמה, "google.com" עבור ספק Google.
uid חוּט מזהה המשתמש של הספק הנתון.

החזרות:

הבטחה< UserRecord >

הבטחה שמומשה עם נתוני המשתמש התואמים את מזהה הספק הנתון.

BaseAuth.getUsers()

מקבל את נתוני המשתמש התואמים למזהים שצוינו.

אין ערבויות הזמנה; בפרט, לא מובטח שהערך ה-n ברשימת התוצאות תואם לערך ה-n ברשימת פרמטרי הקלט.

ניתן לספק עד 100 מזהים לכל היותר. אם מסופקים יותר מ-100 מזהים, שיטה זו זורקת FirebaseAuthError.

חֲתִימָה:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מזהים UserIdentifier [] המזהים המשמשים לציון אילו רשומות משתמש יש להחזיר. לא חייב להיות יותר מ-100 ערכים.

החזרות:

הבטחה< GetUsersResult >

הבטחה שמתפתרת לרשומות המשתמש המתאימות.

חריגים

FirebaseAuthError אם אחד מהמזהים לא חוקי או אם צוינו יותר מ-100 מזהים.

BaseAuth.importUsers()

מייבא את רשימת המשתמשים שסופקה ל-Firebase Auth. מותר לייבא עד 1000 משתמשים אחד בכל פעם. בעת ייבוא ​​משתמשים עם סיסמאות, יש לציין את UserImportOptions . פעולה זו מותאמת לייבוא ​​בכמות גדולה ותתעלם מבדיקות על uid , email וייחודיות מזהה אחרת שעלולה לגרום לכפילויות.

חֲתִימָה:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
משתמשים UserImportRecord [] רשימת רשומות המשתמש לייבא ל-Firebase Auth.
אפשרויות UserImportOptions אפשרויות ייבוא ​​המשתמש, הנדרשות כאשר המשתמשים שסופקו כוללים אישורי סיסמה.

החזרות:

הבטחה< UserImportResult >

הבטחה שנפתרת עם סיום הפעולה עם תוצאת הייבוא. זה כולל את מספר הייבוא ​​המוצלח, מספר הייבוא ​​שנכשל והשגיאות המתאימות להם.

BaseAuth.listProviderConfigs()

מחזירה את רשימת תצורות הספקים הקיימות התואמות למסנן שסופק. לכל היותר, ניתן לרשום 100 תצורות ספק בכל פעם.

תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .

חֲתִימָה:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות AuthProviderConfigFilter מסנן תצורת הספק להחיל.

החזרות:

הבטחה< ListProviderConfigResults >

הבטחה שנפתרת עם רשימת תצורות הספק העומדות בדרישות המסנן.

BaseAuth.listUsers()

מאחזר רשימה של משתמשים (אצווה בודדת בלבד) עם גודל של maxResults החל מההיסט כפי שצוין על ידי pageToken . זה משמש כדי לאחזר את כל המשתמשים של פרויקט מוגדר באצווה.

ראה רשימת כל המשתמשים לקבלת דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
maxResults מספר גודל העמוד, 1000 אם לא מוגדר. זהו גם הגבול המרבי המותר.
pageToken חוּט אסימון העמוד הבא. אם לא צוין, מחזיר משתמשים מתחילים ללא כל היסט.

החזרות:

הבטחה< ListUsersResult >

הבטחה שנפתרת עם אצווה הנוכחית של משתמשים שהורדו ואסימון העמוד הבא.

BaseAuth.revokeRefreshTokens()

מבטל את כל אסימוני הרענון עבור משתמש קיים.

ממשק API זה יעדכן את UserRecord.tokensValidAfterTime של המשתמש ל-UTC הנוכחי. חשוב שהשעון שלו מכוון נכון ומסונכרן לשרת שבו זה נקרא.

אמנם זה יבטל את כל ההפעלות עבור משתמש מסוים ותשבית את ההטבעה של כל אסימוני מזהה חדשים עבור הפעלות קיימות, אך אסימוני מזהה קיימים עשויים להישאר פעילים עד לפקיעת התפוגה הטבעית שלהם (שעה אחת). כדי לוודא שאסימוני מזהה בוטלו, השתמש ב-BaseAuth.verifyIdToken() כאשר checkRevoked מוגדר כ-true.

חֲתִימָה:

revokeRefreshTokens(uid: string): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uid חוּט ה- uid המתאים למשתמש שיש לבטל את אסימוני הרענון שלו.

החזרות:

הבטחה<void>

הבטחה ריקה שמומשה ברגע שאסימוני הרענון של המשתמש בוטלו.

BaseAuth.setCustomUserClaims()

מגדיר תביעות מפתח נוספות על משתמש קיים שזוהה על ידי uid שסופק , משמש בדרך כלל להגדרת תפקידי משתמש ורמות גישה. הטענות הללו צריכות להתפשט לכל המכשירים שבהם המשתמש כבר מחובר (לאחר פקיעת תוקף האסימון או כאשר רענון האסימון נאלץ) ובפעם הבאה שהמשתמש ייכנס. אם נעשה שימוש בשם תביעה שמור של OIDC (תת, iat, iss וכו' ), נזרקת שגיאה. הם מוגדרים על אסימון הזיהוי של המשתמש המאומת JWT.

ראה הגדרת תפקידי משתמש ורמות גישה לדוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uid חוּט ה- uid של המשתמש לעריכה.
customUserClaims חפץ | ריק היזם טוען להגדיר. אם תעבור ריק, תביעות מותאמות אישית קיימות יימחקו. העברת מטען תביעות מותאם אישית גדול מ-1000 בתים יגרום לשגיאה. תביעות מותאמות אישית מתווספות לאסימון הזיהוי של המשתמש המועבר בכל בקשה מאומתת. עבור מאפייני משתמש הקשורים ללא גישה לפרופיל, השתמש במסד נתונים או במערכות אחסון נפרדות אחרות.

החזרות:

הבטחה<void>

הבטחה שנפתרת כאשר הפעולה מסתיימת בהצלחה.

BaseAuth.updateProviderConfig()

מחזירה הבטחה שנפתרת עם AuthProviderConfig המעודכן התואם למזהה הספק שצוין. אם המזהה שצוין לא קיים, נגרמת שגיאת auth/configuration-not-found .

תמיכת ספקי SAML ו-OIDC דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .

חֲתִימָה:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
providerId חוּט מזהה הספק המתאים לתצורת הספק לעדכון.
updatedConfig UpdateAuthProviderRequest התצורה המעודכנת.

החזרות:

הבטחה< AuthProviderConfig >

הבטחה שנפתרת עם תצורת הספק המעודכנת.

BaseAuth.updateUser()

מעדכן משתמש קיים.

ראה עדכון משתמש לקבלת דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
uid חוּט ה- uid המתאים למשתמש שיש לעדכן.
נכסים UpdateRequest המאפיינים שיש לעדכן על המשתמש שסופק.

החזרות:

הבטחה< UserRecord >

הבטחה שהתקיימה עם נתוני המשתמש המעודכנים.

BaseAuth.verifyIdToken()

מאמת אסימון מזהה Firebase (JWT). אם האסימון תקף, ההבטחה מתקיימת עם הטענות המפוענחות של האסימון; אחרת, ההבטחה נדחית.

אם checkRevoked מוגדר כ-true, תחילה מוודא אם המשתמש המתאים מושבת. אם כן, נגרמת שגיאת auth/user-disabled . אם לא, מאמת אם ההפעלה התואמת לאסימון המזהה בוטלה. אם הפגישה של המשתמש התואמת לא הייתה חוקית, נגרמת שגיאת auth/id-token-revoked . אם לא צוין ההמחאה לא מוחלת.

ראה אימות אסימוני מזהה לדוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
idToken חוּט אסימון הזיהוי לאימות.
check Revoked בוליאני האם לבדוק אם אסימון הזיהוי נשלל. זה מחייב בקשה נוספת ל-Firebase Auth backend כדי לבדוק את הזמן tokensValidAfterTime עבור המשתמש המתאים. כאשר לא צוין, הסימון הנוסף הזה אינו מוחל.

החזרות:

הבטחה< DecodedIdToken >

הבטחה שמומשה עם תביעותיו המפוענחות של האסימון אם אסימון הזיהוי תקף; אחרת, הבטחה שנדחתה.

BaseAuth.verifySessionCookie()

מאמת קובץ Cookie של הפעלה של Firebase. מחזיר הבטחה עם טענות העוגיות. דוחה את ההבטחה אם לא ניתן לאמת את העוגייה.

אם checkRevoked מוגדר כ-true, תחילה מוודא אם המשתמש המתאים מושבת: אם כן, נגרמת שגיאת auth/user-disabled . אם לא, מאמת אם ההפעלה התואמת לקובץ ה-cookie של ההפעלה בוטלה. אם ההפעלה של המשתמש התואמת לא בוטלה, נגרמת שגיאה auth/session-cookie-revoked . אם לא צוין הבדיקה לא מבוצעת.

ראה אימות קובצי Cookie של הפעלה לדוגמאות קוד ותיעוד מפורט

חֲתִימָה:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
sessionCookie חוּט קובץ ה-cookie של ההפעלה לאימות.
check Revoked בוליאני

החזרות:

הבטחה< DecodedIdToken >

הבטחה שמומשה עם הטענות המפוענחות של קובץ ה-cookie של ההפעלה אם קובץ ה-cookie של ההפעלה תקף; אחרת, הבטחה שנדחתה.