ממשק Auth מודע לדיירים המשמש לניהול משתמשים, הגדרת ספקי SAML/OIDC, יצירת קישורי דואר אלקטרוני לאיפוס סיסמה, אימות דוא"ל וכו' עבור דיירים ספציפיים.
תמיכה בריבוי דיירים דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP .
כל דייר מכיל ספקי זהות משלו, הגדרות וקבוצות משתמשים. שימוש TenantAwareAuth , ניתן גם לנהל משתמשים עבור דייר ספציפי ותצורות OIDC/SAML מתאימות, ניתן לאמת אסימוני מזהה עבור משתמשים המחוברים לדייר ספציפי, וכן ניתן ליצור קישורי פעולה בדוא"ל עבור משתמשים השייכים לדייר.
ניתן ליצור מופעי TenantAwareAuth עבור tenantId ספציפי על ידי קריאה ל-TenantManager.authForTenant() .
חֲתִימָה:
export declare class TenantAwareAuth extends BaseAuth
מורחבת: BaseAuth
נכסים
| תכונה | משנה | סוּג | תיאור |
|---|---|---|---|
| זיהוי דייר | חוּט | מזהה הדייר המתאים למופע TenantAwareAuth זה. כל הקריאות לממשקי API לניהול משתמשים, ממשקי API לניהול ספקי OIDC/SAML, ממשקי API ליצירת קישורי אימייל וכו' יחולו רק במסגרת הדייר הזה. |
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | יוצר קובץ Cookie חדש להפעלה של Firebase עם האפשרויות שצוינו. ניתן להגדיר את מחרוזת ה-JWT שנוצרה כ-Cookie של הפעלה בצד השרת עם מדיניות קובצי Cookie מותאמת אישית, ולשמש לניהול הפעלה. לעוגיית ההפעלה JWT יהיו אותן תביעות מטען כמו אסימון הזיהוי שסופק. ראה ניהול קובצי Cookie של הפעלה לדוגמאות קוד ותיעוד מפורט. | |
| 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 של הפעלה לדוגמאות קוד ותיעוד מפורט |
TenantAwareAuth.tenantId
מזהה הדייר המתאים למופע TenantAwareAuth זה. כל הקריאות לממשקי API לניהול משתמשים, ממשקי API לניהול ספקי OIDC/SAML, ממשקי API ליצירת קישורי אימייל וכו' יחולו רק במסגרת הדייר הזה.
חֲתִימָה:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
יוצר קובץ Cookie חדש להפעלה של Firebase עם האפשרויות שצוינו. ניתן להגדיר את מחרוזת ה-JWT שנוצרה כ-Cookie של הפעלה בצד השרת עם מדיניות קובצי Cookie מותאמת אישית, ולשמש לניהול הפעלה. לעוגיית ההפעלה JWT יהיו אותן תביעות מטען כמו אסימון הזיהוי שסופק.
ראה ניהול קובצי Cookie של הפעלה לדוגמאות קוד ותיעוד מפורט.
חֲתִימָה:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| idToken | חוּט | אסימון ה-Firebase ID להחלפה בקובץ cookie של הפעלה. |
| sessionCookieOptions | SessionCookieOptions | אפשרויות ה-cookie של ההפעלה הכוללות משך הפעלה מותאם אישית. |
החזרות:
הבטחה<string>
הבטחה שפותרת הצלחה עם עוגיית ההפעלה שנוצרה.
TenantAwareAuth.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 >
הבטחה שמומשה עם תביעותיו המפוענחות של האסימון אם אסימון הזיהוי תקף; אחרת, הבטחה שנדחתה.
TenantAwareAuth.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 של ההפעלה תקף; אחרת, הבטחה שנדחתה.