firebase-admin.auth package

אימות Firebase.

פונקציות

פוּנקצִיָה	תיאור
getAuth(אפליקציה)	מקבל את שירות Auth עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא getAuth() ללא ארגומנטים לגישה לשירות ה- Auth של האפליקציה המוגדרת כברירת מחדל או כ- getAuth(app) לגישה לשירות Auth המשויך לאפליקציה ספציפית.

שיעורים

מעמד	תיאור
Auth	שירות אימות קשור לאפליקציה שסופקה. מופע Auth יכול לכלול מספר דיירים.
BaseAuth	ממשק אב משותף עבור ממשקי API של Auth ו- TenantAwareAuth .
MultiFactorInfo	ממשק המייצג את המאפיינים הנפוצים של גורם שני שנרשם על ידי משתמש.
MultiFactorSettings	הגדרות המשתמש הקשורות לריבוי גורמים.
PhoneMultiFactorInfo	ממשק המייצג גורם שני שנרשם למשתמש ספציפי בטלפון.
ProjectConfig	מייצג תצורת פרויקט.
ProjectConfigManager	מנהל (מקבל ומעדכן) את תצורת הפרויקט הנוכחית.
שׂוֹכֵר	מייצג תצורת דייר. תמיכה בריבוי דיירים דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP . לפני שניתן יהיה להשתמש ב-multi-tenancy בפרויקט Google Cloud Identity Platform, יש לאפשר לדיירים להשתתף בפרויקט זה דרך ממשק המשתמש של Cloud Console. תצורת דייר מספקת מידע כגון שם התצוגה, מזהה הדייר ותצורת אימות הדואר האלקטרוני. עבור ניהול תצורת ספקי OIDC/SAML, יש להשתמש במופעי TenantAwareAuth במקום Tenant כדי לאחזר את רשימת ה-IDPs המוגדרים על דייר. בעת קביעת התצורה של ספקים אלה, שים לב שהדיירים יירשו דומיינים ברשימת ההיתרים וכתובות URI מאומתות להפניה מחדש של פרויקט האב שלהם. גם כל שאר ההגדרות של דייר יעברו בירושה. אלה יצטרכו להיות מנוהלים מהממשק של Cloud Console.
TenantAwareAuth	ממשק Auth מודע לדיירים המשמש לניהול משתמשים, הגדרת ספקי SAML/OIDC, יצירת קישורי דואר אלקטרוני לאיפוס סיסמה, אימות דוא"ל וכו' עבור דיירים ספציפיים. תמיכה בריבוי דיירים דורשת את פלטפורמת הזהות של Google Cloud (GCIP). למידע נוסף על GCIP, כולל תמחור ותכונות, עיין בתיעוד GCIP . כל דייר מכיל ספקי זהות משלו, הגדרות וקבוצות משתמשים. באמצעות TenantAwareAuth , ניתן לנהל גם משתמשים עבור דייר ספציפי ותצורות OIDC/SAML מתאימות, ניתן לאמת אסימוני מזהה עבור משתמשים שנכנסו לדייר ספציפי, וכן ניתן ליצור קישורי פעולה בדוא"ל עבור משתמשים השייכים לדייר. ניתן ליצור מופעי TenantAwareAuth עבור tenantId ספציפי על ידי קריאה ל-TenantManager.authForTenant() .
מנהל דיירים	מגדיר את מנהל הדיירים המשמש לסייע בניהול פעולות הקשורות לדייר. זה כולל: היכולת ליצור, לעדכן, לרשום, לקבל ולמחוק דיירים עבור הפרויקט הבסיסי. קבלת מופע TenantAwareAuth להפעלת פעולות הקשורות ל-Auth (ניהול משתמשים, ניהול תצורת ספק, אימות אסימונים, יצירת קישורים לדוא"ל וכו') בהקשר של דייר שצוין.
מידע על משתמש	מייצג מידע של משתמש מספק זהות של צד שלישי כגון Google או Facebook.
User Metadata	מייצג מטא נתונים של משתמש.
UserRecord	מייצג משתמש.

ממשקים

מִמְשָׁק	תיאור
ActionCodeSettings	זהו הממשק שמגדיר את כתובת האתר הנדרשת להמשך/מצב עם מזהי חבילה אופציונליים של אנדרואיד ו-iOS.
AllowByDefault	מגדיר מדיניות של התרת כל אזור כברירת מחדל והוספת אזורים אסורים לרשימת אסורים.
AllowByDefaultWrap	תצורת אזור SMS בלעדית הדדית של ממשק AllowByDefault
רשימת ההרשאות בלבד	מגדיר מדיניות של התרת אזורים בלבד על ידי הוספה מפורשת לרשימת ההיתרים.
AllowlistOnlyWrap	תצורת אזור SMS של ממשק AllowlistOnly בלעדית הדדית
AuthProviderConfigFilter	ממשק המסנן המשמש לתצורות של ספקי רישום. זה משמש כאשר מציינים כיצד לרשום ספקי זהות מוגדרים באמצעות BaseAuth.listProviderConfigs() .
BaseAuthProviderConfig	ממשק תצורת ספק ה-Auth הבסיסי.
BaseCreateMultiFactorInfoRequest	ממשק המייצג מאפייני בסיס של גורם שני שנרשם על ידי משתמש עבור CreateRequest .
BaseUpdateMultiFactorInfoRequest	ממשק המייצג מאפיינים נפוצים של גורם שני שנרשם על ידי משתמש עבור UpdateRequest .
CreatePhoneMultiFactorInfoRequest	ממשק המייצג גורם שני שנרשם לטלפון ספציפי עבור CreateRequest .
CreateRequest	ממשק המייצג את המאפיינים שיש להגדיר ברשומת משתמש חדשה שתיווצר.
CustomStrengthOptionsConfig	אילוצים שיש לאכוף על מדיניות הסיסמאות
DecodedIdToken	ממשק המייצג אסימון Firebase ID מפוענח, שהוחזר מהשיטה BaseAuth.verifyIdToken() ‎. אסימוני Firebase ID הם אסימוני JSON Web (JWT) התואמים למפרט OpenID Connect. עיין ב[קטע ID Token של מפרט OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) למידע נוסף על המאפיינים הספציפיים למטה.
מחקUsersResult	מייצג את התוצאה של BaseAuth.deleteUsers() . ממשק API.
EmailIdentifier	משמש לחיפוש חשבון בדוא"ל. ראה BaseAuth.getUsers() .
EmailPrivacyConfig	תצורת פרטיות הדוא"ל של פרויקט או דייר.
EmailSignInProviderConfig	תצורת ספק הכניסה לאימייל.
GetUsersResult	מייצג את התוצאה של BaseAuth.getUsers() API.
ListProviderConfigResults	ממשק התגובה עבור תצורות ספקי הרישום. זה זמין רק כשמפרטים את כל התצורות של ספקי הזהות באמצעות BaseAuth.listProviderConfigs() .
הרשמת תוצאה של דיירים	ממשק המייצג את האובייקט שהוחזר מפעולת TenantManager.listTenants() ‎. מכיל את רשימת הדיירים עבור האצווה הנוכחית ואת אסימון העמוד הבא אם זמין.
ListUsersResult	ממשק המייצג את האובייקט המוחזר מפעולת BaseAuth.listUsers() ‎. מכיל את רשימת המשתמשים עבור האצווה הנוכחית ואת אסימון העמוד הבא אם זמין.
MultiFactorConfig	ממשק המייצג תצורה מרובת גורמים. זה יכול לשמש כדי להגדיר אם אימות רב-גורמי מופעל או מושבת ואת רשימת אתגרי הגורם השני הנתמכים.
MultiFactorCreateSettings	הגדרות המשתמש הקשורות לריבוי גורמים עבור פעולות יצירה.
MultiFactorProviderConfig	ממשק המייצג תצורת ספק אימות מרובה גורמים. ממשק זה משמש עבור ספקי אימות גורם שני מלבד SMS. נכון לעכשיו, רק TOTP נתמך.
MultiFactorUpdateSettings	הגדרות המשתמש הקשורות לריבוי גורמים עבור פעולות עדכון.
OAuthResponseType	הממשק המייצג את אובייקט התגובה של ספק OIDC עבור זרימת הרשאות OAuth. נדרשת אחת מההגדרות הבאות: הגדר code כ- true עבור זרימת הקוד. הגדר idToken ל- true עבור זרימת אסימון המזהה.
OIDCAuthProviderConfig	ממשק התצורה של ספק האימות [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). ניתן ליצור ספק OIDC באמצעות BaseAuth.createProviderConfig() .
OIDCUpdateAuthProviderRequest	ממשק הבקשה לעדכון ספק OIDC Auth. זה משמש בעת עדכון תצורה של ספק OIDC באמצעות BaseAuth.updateProviderConfig() .
PasswordPolicyConfig	תצורת מדיניות סיסמה עבור פרויקט או דייר
PhoneIdentifier	משמש לחיפוש חשבון לפי מספר טלפון. ראה BaseAuth.getUsers() .
ProviderIdentifier	משמש לחיפוש חשבון על ידי ספק מאוחד. ראה BaseAuth.getUsers() .
RecaptchaConfig	ממשק הבקשה לעדכון תצורת reCAPTCHA. על ידי הפעלת reCAPTCHA Enterprise Integration אתה מסכים לתקופת השירות של reCAPTCHA Enterprise .
RecaptchaKey	תצורת מפתח reCAPTCHA.
RecaptchaManagedRule	התצורה של כלל פעולה reCAPTCHA.
SAMLAuthProviderConfig	ממשק התצורה של ספק האימות [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). ניתן ליצור ספק SAML באמצעות BaseAuth.createProviderConfig() .
SAMLUpdateAuthProviderRequest	ממשק הבקשה לעדכון ספק SAML Auth. זה משמש בעת עדכון תצורה של ספק SAML באמצעות BaseAuth.updateProviderConfig() .
SessionCookieOptions	ממשק המייצג את אפשרויות ה-cookie של ההפעלה הדרושות עבור שיטת BaseAuth.createSessionCookie() ‎.
TotpMultiFactorProviderConfig	ממשק המייצג הגדרות תצורה עבור אימות גורם שני של TOTP.
UidIdentifier	משמש לחיפוש חשבון על ידי uid. ראה BaseAuth.getUsers() .
UpdatePhoneMultiFactorInfoRequest	ממשק המייצג גורם שני שנרשם לטלפון ספציפי עבור UpdateRequest .
UpdateProjectConfigRequest	ממשק המייצג את המאפיינים לעדכון בתצורת הפרוייקט שסופקה.
UpdateRequest	ממשק המייצג את המאפיינים שיש לעדכן על המשתמש שסופק.
UpdateTenantRequest	ממשק המייצג את הנכסים לעדכון על השוכר המסופק.
UserImportOptions	ממשק המייצג את אפשרויות ייבוא ​​המשתמש הדרושות עבור שיטת BaseAuth.importUsers() . זה משמש כדי לספק מידע על אלגוריתם הגיבוב סיסמה.
UserImportRecord	ממשק המייצג משתמש לייבא ל-Firebase Auth באמצעות שיטת BaseAuth.importUsers() ‎.
UserImportResult	ממשק המייצג את התגובה משיטת BaseAuth.importUsers() לייבוא ​​משתמשים באצווה ל-Firebase Auth.
UserMetadataRequest	מטא נתונים של משתמש שיש לכלול בעת ייבוא ​​משתמש.
UserProvider	מייצג ספק זהות משתמש שניתן לשייך למשתמש Firebase.
UserProviderRequest	נתוני ספק משתמש שיש לכלול בעת ייבוא ​​משתמש.

הקלד כינויים

הקלד כינוי	תיאור
AuthFactorType	מזהה סוג גורם שני.
AuthProviderConfig	סוג התצורה של ספק האימות. BaseAuth.createProviderConfig() .
CreateMultiFactorInfoRequest	סוג המייצג את המאפיינים של גורם שני שנרשם על ידי משתמש עבור CreateRequest .
CreateTenantRequest	ממשק המייצג את הנכסים שיש להגדיר על דייר חדש.
HashAlgorithmType
MultiFactorConfigState	מזהה מצב תצורה מרובה גורמים.
PasswordPolicyEnforcementState	מצב אכיפה של מדיניות סיסמאות.
RecaptchaAction	הפעולות שיש לנקוט עבור בקשות מוגנות reCAPTCHA. - 'BLOCK': הבקשה המוגנת reCAPTCHA תיחסם.
RecaptchaKeyClientType	סוג הפלטפורמה של המפתח.
RecaptchaProviderEnforcementState	מצב אכיפה של הגנת reCAPTCHA. - 'OFF': לא נאכף. - 'ביקורת': צור הערכה אך אל תאכוף את התוצאה. - 'אכיפה': צור הערכה ואכוף את התוצאה.
SmsRegionConfig	ממשק הבקשה לעדכון תצורת אזור SMS. מגדיר את האזורים שבהם משתמשים רשאים לשלוח SMS אימות. זה מבוסס על קוד החיוג של מספר הטלפון של היעד.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	סוג המייצג את המאפיינים של גורם שני שנרשם על ידי משתמש עבור UpdateRequest .
UserIdentifier	מזהה משתמש שיש לחפש אותו.

getAuth()

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

ניתן לקרוא getAuth() ללא ארגומנטים לגישה לשירות ה- Auth של האפליקציה המוגדרת כברירת מחדל או כ- getAuth(app) לגישה לשירות Auth המשויך לאפליקציה ספציפית.

חֲתִימָה:

export declare function getAuth(app?: App): Auth;

פרמטרים

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

החזרות:

Auth

דוגמה 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

דוגמה 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

AuthFactorType

מזהה סוג גורם שני.

חֲתִימָה:

export type AuthFactorType = 'phone';

AuthProviderConfig

סוג התצורה של ספק האימות. BaseAuth.createProviderConfig() .

חֲתִימָה:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

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

חֲתִימָה:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

ממשק המייצג את הנכסים שיש להגדיר על דייר חדש.

חֲתִימָה:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

חֲתִימָה:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

MultiFactorConfigState

מזהה מצב תצורה מרובה גורמים.

חֲתִימָה:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

PasswordPolicyEnforcementState

מצב אכיפה של מדיניות סיסמאות.

חֲתִימָה:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RecaptchaAction

הפעולות שיש לנקוט עבור בקשות מוגנות reCAPTCHA. - 'BLOCK': הבקשה המוגנת reCAPTCHA תיחסם.

חֲתִימָה:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

סוג הפלטפורמה של המפתח.

חֲתִימָה:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState

מצב אכיפה של הגנת reCAPTCHA. - 'OFF': לא נאכף. - 'ביקורת': צור הערכה אך אל תאכוף את התוצאה. - 'אכיפה': צור הערכה ואכוף את התוצאה.

חֲתִימָה:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig

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

חֲתִימָה:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

חֲתִימָה:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

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

חֲתִימָה:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

UserIdentifier

מזהה משתמש שיש לחפש אותו.

חֲתִימָה:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;