firebase-admin.auth package

אימות Firebase.

פונקציות

שיעורים

ממשקים

הקלד כינויים

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;