firebase-admin.auth package

مصادقة Firebase.

الدوال

دالة	الوصف
getAuth(app)	يحصل على خدمة المصادقة للتطبيق التلقائي أو تطبيق معيّن.ويمكن استدعاء getAuth() بدون وسيطات للوصول إلى خدمة Auth للتطبيق التلقائي أو الوصول إلى خدمة Auth المرتبطة بتطبيق معيّن.getAuth(app)

صفوف

الفئة	الوصف
المصادقة	خدمة المصادقة المرتبطة بالتطبيق المقدَّم. يمكن أن يكون لمثيل Auth عدة مستأجرين.
AuthClientErrorCode	رموز الخطأ في عميل المصادقة ورسائلها التلقائية.
BaseAuth	واجهة رئيسية مشتركة لكل من واجهتَي برمجة التطبيقات Auth وTenantAwareAuth
FirebaseAuthError	بنية رمز خطأ مصادقة Firebase. يؤدي ذلك إلى تمديد PrefixedFirebaseError.
متعدد العوامل	واجهة تمثّل الخصائص الشائعة للعامل الثاني المُسجّل بواسطة المستخدم.
إعدادات متعدّدة العوامل	إعدادات المستخدم المرتبطة بعدة عوامل.
PhoneMultiFactorInfo	واجهة تمثِّل العامل الثاني الذي تم تسجيله من قِبل المستخدم على الهاتف محدَّد.
إعدادات المشروع	يمثل تكوين مشروع.
ProjectConfigManager	يدير (يحصل ويحدث) تكوين المشروع الحالي.
المستأجر	يمثل هذا الإعداد إعدادات المستأجر.يتطلّب دعم "الإقامة المتعددة" توفّر "منصة إدارة الهوية" (GCIP) من Google Cloud. لمعرفة مزيد من المعلومات عن برنامج GCIP، بما في ذلك الأسعار والميزات، يُرجى الاطّلاع على مستندات GCIP.قبل التمكّن من استخدام الإقامة المتعددة في مشروع Google Cloud Identity Platform، يجب السماح للمستأجرين في هذا المشروع من خلال واجهة مستخدم Cloud Console.يوفِّر إعداد المستأجر معلومات مثل الاسم المعروض ومعرّف المستأجر وإعدادات مصادقة البريد الإلكتروني. لإدارة إعداد موفّر خدمة OIDC/SAML، يجب استخدام نسخة افتراضية من TenantAwareAuth بدلاً من Tenant لاسترداد قائمة موفِّري الهوية الذين تم ضبطهم على حساب مستأجر. عند إعداد هؤلاء المزوّدين، يُرجى ملاحظة أنّ المستأجرين سيكتسبون النطاقات المدرَجة في القائمة البيضاء ومعرّفات الموارد المنتظمة (URI) التي تمت المصادقة عليها لإعادة التوجيه في المشروع الرئيسي.سيتم أيضًا اكتساب جميع الإعدادات الأخرى للمستأجر. ويجب إدارتها من خلال واجهة مستخدم Cloud Console.
TenantAwareAuth	واجهة Auth الواعية للمستأجرين وتُستخدَم لإدارة المستخدمين، وإعداد موفّري SAML/OIDC، وإنشاء روابط البريد الإلكتروني لإعادة ضبط كلمة المرور، والتحقق من عنوان البريد الإلكتروني، وما إلى ذلك مستأجرين محدّدين.يتطلّب دعم الإقامة المتعددة استخدام منصة الهوية (GCIP) من Google Cloud. لمعرفة المزيد من المعلومات عن برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات GCIP.يحتوي كل مستأجر على موفِّري الهوية والإعدادات ومجموعات المستخدمين الخاصة به. باستخدام TenantAwareAuth، يمكن أيضًا إدارة مستخدمي مستأجر محدّد وإعدادات OIDC/SAML المقابلة، كما يمكن إثبات صحة الرموز المميّزة للتعريف للمستخدمين الذين سجّلوا الدخول إلى مستأجر محدّد، ويمكن أيضًا إنشاء روابط إجراءات عبر البريد الإلكتروني للمستخدمين الذين ينتمون إلى المستأجر.TenantAwareAuth يمكن إنشاء مثيل TenantAwareAuth لـ tenantId محدّد من خلال استدعاء TenantManager.authForTenant().
TenantManager	يحدد المدير المستأجر المستخدم للمساعدة في إدارة العمليات المتعلقة بالمستأجر. ويتضمن ذلك: يشير هذا المصطلح إلى القدرة على إنشاء مستأجرين للمشروع الأساسي وإدراجهم في قائمة والحصول عليهم وحذفهم. الحصول على مثال TenantAwareAuth لتشغيل العمليات المتعلّقة بالمصادقة (إدارة المستخدمين، وإدارة إعدادات موفّر الخدمة، والتحقق من الرموز المميزة، وإنشاء روابط البريد الإلكتروني، وما إلى ذلك) في سياق مستأجر محدّد
معلومات المستخدم	تمثل معلومات مستخدم من موفِّر هوية تابع لجهة خارجية، مثل Google أو Facebook.
UserMetadata	يمثل ذلك البيانات الوصفية لمستخدم.
UserRecord (تسجيل المستخدم)	يمثل مستخدمًا.

واجهات

الواجهة	الوصف
ActionCodeSettings	هذه هي الواجهة التي تحدِّد عنوان URL المطلوب للمتابعة/الحالة مع معرّفات حِزم Android وiOS الاختيارية.
AllowByDefault	تحدد هذه السياسة سياسة السماح لكل منطقة بشكل تلقائي وإضافة المناطق غير المسموح فيها إلى قائمة الحظر.
AllowByDefaultWrap	إعداد منطقة الرسائل القصيرة SMS الحصرية المتبادلة لواجهة AllowByDefault
القائمة المسموح بها فقط	تحدِّد هذه السياسة سياسة السماح بالمناطق فقط من خلال إضافتها صراحةً إلى القائمة المسموح بها.
AllowlistOnlyWrap	إعداد منطقة الرسائل القصيرة SMS الحصرية المتبادلة لواجهة AllowlistOnly
AuthProviderConfigFilter	واجهة الفلتر المستخدَمة لإعدادات موفّري بطاقات بيانات المتجر يتم استخدام ذلك عند تحديد كيفية إدراج موفِّري الهوية الذين تم ضبط إعداداتهم من خلال BaseAuth.listProviderConfigs().
BaseAuthProviderConfig	واجهة إعداد موفّر المصادقة الأساسي
BaseCreateMultiFactorInfoRequest	واجهة تمثّل الخصائص الأساسية للعامل الثاني المسجَّل للمستخدم لـ CreateRequest
BaseUpdateMultiFactorInfoRequest	واجهة تمثّل الخصائص المشتركة للعامل الثاني الذي تم تسجيله بواسطة المستخدم لـ UpdateRequest.
CreatePhoneMultiFactorInfoRequest	واجهة تمثِّل العامل الثاني الذي يحمله المستخدم ويسجِّله المستخدم لـ CreateRequest.
إنشاء طلب	واجهة تمثّل السمات المطلوب ضبطها على سجلّ مستخدم جديد ليتم إنشاؤها
CustomStrengthOptionsConfig	القيود التي سيتم فرضها على سياسة كلمة المرور
DecodedAuthBlockToken
DecodedIdToken	واجهة تمثّل رمزًا مميّزًا لمعرّف Firebase تم فك ترميزه، ويتم عرضه من خلال طريقة BaseAuth.verifyIdToken().إنّ الرموز المميّزة لمعرّف Firebase هي رموز ويب JSON مميّزة على الويب (JWT) تم فك ترميزها. راجع [قسم الرمز المميز للمعرّف ضمن مواصفات OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) للحصول على مزيد من المعلومات حول الخصائص المحددة أدناه.
DeleteUsersResult (حذف المستخدمين)	تمثل هذه السمة نتيجة BaseAuth.deleteUsers(). واجهة برمجة التطبيقات.
EmailIdentifier	يتم استخدامه للبحث عن حساب بالبريد الإلكتروني.يُرجى الاطّلاع على BaseAuth.getUsers().
EmailPrivacyConfig	يشير ذلك المصطلح إلى إعدادات خصوصية البريد الإلكتروني لمشروع أو مستأجر.
EmailSignInProviderConfig	إعدادات مزوِّد خدمة تسجيل الدخول إلى البريد الإلكتروني
GetUsersResult	يمثل هذا الإعداد نتيجة واجهة برمجة التطبيقات BaseAuth.getUsers().
ListProviderConfigResults	واجهة الاستجابة لإعدادات موفِّر بطاقة بيانات المتجر لا تتوفّر هذه الميزة إلا عند عرض بيانات جميع موفِّري الهوية من خلال BaseAuth.listProviderConfigs().
ListTenantsResult	واجهة تمثِّل الكائن الذي يتم عرضه من خلال عملية TenantManager.listTenants(). يحتوي على قائمة مستأجرين الدفعة الحالية والرمز المميز للصفحة التالية إذا كان متاحًا.
ListUsersResult	واجهة تمثّل الكائن الذي يتم عرضه من عملية BaseAuth.listUsers(). يحتوي على قائمة مستخدمي الدُفعة الحالية والرمز المميّز للصفحة التالية في حال توفّره.
الإعداد المتعدد العوامل	واجهة تمثّل إعدادًا متعدد العوامل ويمكن استخدام ذلك لتحديد ما إذا كانت المصادقة المتعدّدة العوامل مفعَّلة أو متوقّفة، والاطّلاع على قائمة بتحديات العامل الثاني المتاحة.
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 ويتم استخدامها عند تعديل إعدادات موفّر 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. ويتم استخدام ذلك عند تعديل إعدادات موفّر SAML من خلال BaseAuth.updateProviderConfig().
sessionCookieOptions	واجهة تمثِّل خيارات ملفات تعريف الارتباط للجلسة اللازمة لطريقة BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig	واجهة تمثل إعدادات الضبط لمصادقة العامل الثاني لـ TOTP.
معرّف UidIdentifier	يتم استخدامه للبحث عن حساب باستخدام uid.يُرجى الاطّلاع على BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest	واجهة تمثِّل العامل الثاني الذي يحمله المستخدم ويسجِّله المستخدم لـ UpdateRequest.
UpdateProjectConfigRequest	واجهة تمثِّل السمات المطلوب تعديلها في إعدادات المشروع المقدَّمة
طلب التحديث	واجهة تمثّل السمات المطلوب تعديلها على المستخدم المقدّم
UpdateTenantRequest	واجهة تمثّل السمات المطلوب تحديثها على المستأجر المقدَّم.
UserImportOptions	واجهة تمثِّل خيارات استيراد المستخدم اللازمة لطريقة BaseAuth.ImportUsers(). يُستخدَم هذا الإجراء لتوفير معلومات خوارزمية تجزئة كلمة المرور.
UserImportRecord	واجهة تمثل مستخدمًا للاستيراد إلى مصادقة Firebase عبر طريقة BaseAuth.ImportUsers().
UserImportResult	واجهة تمثل الاستجابة من طريقة BaseAuth.ImportUsers() لعمليات استيراد المستخدمين على دفعات إلى مصادقة Firebase.
UserMetadataRequest	البيانات الوصفية للمستخدم المطلوب تضمينها عند استيراد مستخدم
UserProvider	تمثّل هذه السمة موفِّر هوية مستخدم يمكن ربطه بأحد مستخدمي Firebase.
UserProviderRequest	بيانات موفّر المستخدم المطلوب تضمينها عند استيراد مستخدم

كتابة العناوين البديلة للبريد الإلكتروني

اكتب العنوان البديل للبريد الإلكتروني	الوصف
AuthFactorType	تحدد نوع عامل ثانٍ.
AuthProviderConfig	نوع إعداد موفّر المصادقة BaseAuth.createProviderConfig():
CreateMultiFactorInfoRequest	اكتب هو خصائص العامل الثاني الذي تم تسجيله بواسطة المستخدم لـ CreateRequest.
CreateTenantRequest	واجهة تمثّل السمات التي يجب ضبطها على مستأجر جديد
HashAlgorithmType
MultiFactorConfigState	يحدد حالة ضبط متعدد العوامل.
PasswordPolicyPolicymentState	حالة تنفيذ سياسة كلمات المرور
RecaptchaAction	الإجراءات التي يجب اتّخاذها للطلبات المحمية بموجب reCAPTCHA. - "حظر": سيتم حظر الطلب المحمي باستخدام reCAPTCHA.
RecaptchaKeyClientType	نوع النظام الأساسي للمفتاح.
RecaptchaProviderImplementmentState	حالة تنفيذ حماية reCAPTCHA. - "إيقاف": غير إلزامي. - "AUDIT": إنشاء تقييم بدون فرض النتيجة. - "ENFORCE": إنشاء تقييم وتنفيذ النتيجة.
SmsRegionConfig	واجهة الطلب لتعديل إعدادات منطقة الرسائل القصيرة تحدِّد هذه السياسة المناطق التي يُسمح فيها للمستخدمين بإرسال رسالة قصيرة SMS لإثبات الملكية. ويعتمد ذلك على رمز الاتصال لرقم الهاتف الوجهة.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	اكتب هو خصائص العامل الثاني الذي تم تسجيله بواسطة المستخدم لـ UpdateRequest.
UserIdentifier	تحدد المستخدم الذي سيتم البحث عنه.

getAuth(app)

الحصول على خدمة المصادقة للتطبيق التلقائي أو تطبيق معيَّن

يمكن استدعاء getAuth() بدون أي وسيطات للوصول إلى خدمة Auth للتطبيق التلقائي أو getAuth(app) للوصول إلى خدمة Auth المرتبطة بتطبيق معيّن.

Signature:

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);

نوع عنصر المصادقة

تحدد نوع عامل ثانٍ.

Signature:

export type AuthFactorType = 'phone';

إعداد AuthProviderConfig

نوع إعداد موفّر المصادقة BaseAuth.createProviderConfig():

Signature:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

إنشاء طلب متعدد العوامل

اكتب هو خصائص العامل الثاني الذي تم تسجيله من قِبل المستخدم لـ CreateRequest.

Signature:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

طلب إنشاءTenantRequest

واجهة تمثّل السمات التي يجب ضبطها على مستأجر جديد

Signature:

export type CreateTenantRequest = UpdateTenantRequest;

نوع خوارزمية التجزئة

Signature:

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

حالة الإعدادات المتعددة

يحدد حالة ضبط متعدد العوامل.

Signature:

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

حالة تنفيذ سياسة كلمة المرور

حالة تنفيذ سياسة كلمات المرور

Signature:

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

reCAPTCHA

الإجراءات التي يجب اتّخاذها للطلبات المحمية بموجب reCAPTCHA. - "حظر": سيتم حظر الطلب المحمي باستخدام reCAPTCHA.

Signature:

export type RecaptchaAction = 'BLOCK';

reCAPTCHAKeyClientType

نوع النظام الأساسي للمفتاح.

Signature:

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

حالة تنفيذ reCAPTCHA

حالة تنفيذ حماية reCAPTCHA. - "إيقاف": غير إلزامي. - "AUDIT": إنشاء تقييم بدون فرض النتيجة. - "ENFORCE": إنشاء تقييم وتنفيذ النتيجة.

Signature:

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

ضبط إعدادات خدمة SmsRegion

واجهة الطلب لتعديل إعدادات منطقة الرسائل القصيرة تحدِّد هذه السياسة المناطق التي يُسمح فيها للمستخدمين بإرسال رسالة قصيرة SMS لإثبات الملكية. ويعتمد ذلك على رمز الاتصال لرقم الهاتف الوجهة.

Signature:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

طلب UpdateAuthProviderRequest

Signature:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

طلب تعديل MultiFactorInfoRequest

اكتب هو خصائص العامل الثاني الذي تم تسجيله بواسطة المستخدم لـ UpdateRequest.

Signature:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

معرِّف المستخدم

تحدد المستخدم الذي سيتم البحث عنه.

Signature:

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