firebase-admin.auth package

احراز هویت Firebase.

کارکرد

کلاس ها

رابط ها

نام مستعار را تایپ کنید

getAuth()

سرویس Auth را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند.

getAuth() را می توان بدون هیچ آرگومان برای دسترسی به سرویس Auth برنامه پیش فرض یا به عنوان getAuth(app) برای دسترسی به سرویس Auth مرتبط با یک برنامه خاص فراخوانی کرد.

امضا:

export declare function getAuth(app?: App): 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

نوع پیکربندی ارائه دهنده Auth. 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. - "خاموش": اجرا نشده است. - "حسابرسی": ارزیابی را ایجاد کنید اما نتیجه را اجرا نکنید. - "اجرا": ارزیابی را ایجاد کنید و نتیجه را اجرا کنید.

امضا:

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

SmsRegionConfig

رابط درخواست برای به‌روزرسانی یک پیکربندی منطقه 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;