مصادقة Firebase.
الوظائف
الوظيفة | الوصف |
---|---|
getAuth(app) | يتم الحصول على خدمة Auth للتطبيق التلقائي أو لتطبيق محدَّد.يمكن استدعاء getAuth() بدون وسيطات للوصول إلى خدمة Auth في التطبيق التلقائي، أو كـ getAuth(app) للوصول إلى خدمة Auth المرتبطة بتطبيق معيّن. |
صفوف
الفئة | الوصف |
---|---|
المصادقة | خدمة المصادقة مرتبطة بالتطبيق المتوفر. ويمكن أن يشتمل مثيل Auth على مستأجرين متعددين. |
AuthClientErrorCode | رموز خطأ عميل المصادقة ورسائلها التلقائية |
BaseAuth | واجهة رئيسية مشتركة لكل من واجهات برمجة التطبيقات Auth وTenantAwareAuth |
خطأ مصادقة Firebase | بنية رمز الخطأ لمصادقة Firebase يؤدي ذلك إلى امتداد PrefixedFirebaseError. |
معلومات متعددة العوامل | واجهة تمثّل الخصائص الشائعة للعامل الثاني المسجَّل بواسطة المستخدم. |
إعدادات متعددة العوامل | إعدادات المستخدم ذات الصلة بعوامل متعددة. |
PhoneMultiFactorInfo | واجهة تمثِّل العامل الثاني المُسجَّل في هاتف شخص معيّن |
ProjectConfig | يمثل تكوين المشروع. |
ProjectConfigManager | إدارة (الحصول على التحديثات) تهيئة المشروع الحالي |
مستأجر | يمثّل الإعداد الخاص بالمستأجرين.تتطلب خدمة الدعم المتعدّد العملاء توفُّر Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات عن بروتوكول GCIP، بما في ذلك الأسعار والميزات، يُرجى الاطّلاع على مستندات برنامج GCIP.قبل استخدام نظام GCIP المتعدد في مشروع Google Cloud Identity Platform، يجب السماح للمستأجرين بالانضمام إلى هذا المشروع من خلال واجهة مستخدم Cloud Console.توفّر إعدادات المستأجر معلومات، مثل الاسم المعروض ومعرّف المستأجر وإعدادات مصادقة البريد الإلكتروني. بالنسبة إلى إدارة إعداد موفّر OIDC/SAML، يجب استخدام مثيلات TenantAwareAuth بدلاً من Tenant لاسترداد قائمة موفِّري الهوية الذين تم ضبط إعداداتهم على جهاز مستأجر. عند إعداد مقدّمي الخدمات هؤلاء، يُرجى ملاحظة أن المستأجرين سيكتسبون النطاقات المضافة إلى القائمة البيضاء ومعرّفات الموارد المنتظمة (URI) لإعادة التوجيه التي تمت مصادقتها لمشروعهم الرئيسي.سيتم أيضًا اكتساب جميع الإعدادات الأخرى للمستأجر. يجب إدارة هذه العناصر من واجهة مستخدم Cloud Console. |
TenantAwareAuth | يتم استخدام واجهة Auth المستأجرة لإدارة المستخدمين، وضبط موفّري SAML/OIDC، وإنشاء روابط بريد إلكتروني لإعادة ضبط كلمة المرور وإثبات ملكية عنوان البريد الإلكتروني وما إلى ذلك لمستأجرين محدّدين.يتطلب الدعم المتعدّد العملاء منصة Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات عن برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.يحتوي كل مستأجر على موفّري الهوية والإعدادات ومجموعات المستخدمين الخاصة به. وباستخدام TenantAwareAuth ، يمكن أيضًا إدارة مستخدمي مستأجر محدّد وإعدادات OIDC/SAML المقابلة، كما يمكن التحقّق من الرموز المميّزة لرقم التعريف للمستخدمين الذين سجّلوا الدخول إلى مستأجر معيّن، كما يمكن إنشاء روابط الإجراءات عبر البريد الإلكتروني للمستخدمين الذين ينتمون إلى المستأجر.ويمكن إنشاء مثيل لمثيلات TenantAwareAuth لـ tenantId معيّنة من خلال طلب TenantManager.authForTenant(). |
مدير المستأجر | تحدد مدير المستأجر المستخدم للمساعدة في إدارة العمليات المتعلقة بالمستأجر. ويشمل ذلك ما يلي:
|
معلومات المستخدم | تمثِّل معلومات المستخدم من موفِّر هوية تابع لجهة خارجية، مثل Google أو Facebook. |
UserMetadata | تمثل البيانات الوصفية للمستخدم. |
سجلّ المستخدم | يمثل المستخدم. |
الواجهات
الواجهة | الوصف |
---|---|
ActionCodeSettings | هذه هي الواجهة التي تحدّد عنوان URL للمتابعة/الحالة المطلوب بمعرِّفات حِزمة Android وiOS الاختيارية. |
AllowByDefault | تحدد هذه السياسة سياسة السماح لكل منطقة تلقائيًا وإضافة المناطق غير المسموح بها إلى قائمة الحظر. |
AllowByDefaultWrap | تهيئة حصرية متبادلة لمنطقة الرسائل القصيرة SMS لواجهة AllowByDefault |
القائمة المسموح بها فقط | تحدِّد هذه السياسة سياسة بالسماح للمناطق فقط بإضافتها صراحةً إلى قائمة مسموح بها. |
AllowlistOnlyWrap | إعدادات حصرية في منطقة الرسائل القصيرة SMS لواجهة القائمة المسموح بها فقط |
AuthProviderConfigFilter | واجهة الفلتر المستخدَمة لإعدادات إعداد موفِّر البيانات. يُستخدم هذا عند تحديد طريقة إدراج موفّري الهوية الذين تم ضبط إعداداتهم من خلال BaseAuth.listProviderConfigs(). |
BaseAuthProviderConfig | واجهة إعداد موفّر المصادقة الأساسي |
BaseCreateMultiFactorInfoRequest | واجهة تمثِّل الخصائص الأساسية للعامل الثاني المُسجَّل في المستخدم CreateRequest |
BaseUpdateMultiFactorInfoRequest | واجهة تمثّل الخصائص الشائعة للعامل الثاني الذي سجّله المستخدم في UpdateRequest . |
CreatePhoneMultiFactorInfoRequest | واجهة تمثِّل العامل الثاني الخاص بالهاتف الذي سجّله مستخدم في CreateRequest . |
CreateRequest | واجهة تمثّل السمات المطلوب ضبطها في سجلّ مستخدِم جديد سيتم إنشاؤه. |
CustomStrengthOptionsConfig | القيود التي يجب فرضها على سياسة كلمة المرور |
DecodedAuthBlockToken | |
DecodedIdToken | واجهة تمثِّل رمزًا مميّزًا لمعرّف Firebase تمّ فك ترميزه، ويظهر من خلال طريقة BaseAuth.verifyIdToken().الرموز المميّزة لمعرّف Firebase هي رموز JSON للويب (JWT) متوافقة مع مواصفات OpenID Connect. راجع [قسم الرمز المميز للمعرف في مواصفات 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 | واجهة تمثِّل إعدادات موفّر مصادقة متعدّدة العوامل يتم استخدام هذه الواجهة للعامل الثاني لموفّري المصادقة باستثناء الرسائل القصيرة. في الوقت الحالي، لا يتوفّر سوى TOTP. |
إعدادات تحديث متعدد العوامل | إعدادات المستخدم المتعددة العوامل ذات الصلة لعمليات التحديث. |
OAuthResponseType | الواجهة التي تمثّل كائن استجابة موفّر OIDC لمسار تفويض OAuth. يجب تحديد أحد الإعدادات التالية:
|
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(). |
معرّف الخدمة | يُستخدم للبحث عن حساب من قِبل مقدِّم خدمة موحَّد.راجِع BaseAuth.getUsers(). |
اختبار reCAPTCHA | واجهة الطلب لتعديل إعدادات reCAPTCHA من خلال تفعيل reCAPTCHA Enterprise Integration، أنت توافق على بنود خدمة reCAPTCHA Enterprise. |
مفتاح reCAPTCHA | إعدادات مفتاح 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 | واجهة تمثّل الخصائص المطلوب تحديثها على إعدادات المشروع المقدّمة. |
UpdateRequest | واجهة تمثّل السمات التي يجب تعديلها عن المستخدم المقدَّم |
UpdateTenantRequest | واجهة تمثِّل العقارات المطلوب تعديلها في المستأجر المقدَّم |
UserImportOptions | واجهة تمثّل خيارات استيراد المستخدم المطلوبة لطريقة BaseAuth.importUsers() يُستخدم هذا لتوفير معلومات خوارزمية تجزئة كلمة المرور. |
UserImportLog | واجهة تمثِّل مستخدمًا تريد استيراده إلى مصادقة Firebase من خلال طريقة BaseAuth.importUsers(). |
UserImportResult | واجهة تمثل الاستجابة من طريقة BaseAuth.importUsers() لمجموعات المستخدمين التي يتم استيراد المستخدمين إلى مصادقة Firebase |
UserMetadataRequest | البيانات الوصفية للمستخدم المطلوب تضمينها عند استيراد مستخدم. |
UserProvider | يمثل موفِّر هوية المستخدم الذي يمكن ربطه بمستخدِم Firebase. |
UserProviderRequest | بيانات موفِّر المستخدِم لتضمينها عند استيراد مستخدِم. |
الأسماء المستعارة للنوع
النوع البديل | الوصف |
---|---|
AuthFactorType | تحدد نوع عامل ثانٍ. |
AuthProviderConfig | نوع ضبط موفِّر المصادقة BaseAuth.createProviderConfig(). |
CreateMultiFactorInfoRequest | النوع الذي يمثّل خصائص العامل الثاني الذي سجّله المستخدم في CreateRequest . |
CreateTenantRequest | واجهة تمثّل المواقع المطلوب وضعها على مستأجر جديد. |
تجزئة الخوارزمية | |
MultiFactorConfigState | تحدد حالة تهيئة متعددة العوامل. |
PasswordPolicyforcementState | حالة تنفيذ سياسة كلمة المرور. |
اختبار reCAPTCHA | تمثّل هذه السمة الإجراءات التي يجب اتّخاذها للطلبات المحمية من reCAPTCHA. - "حظر": سيتم حظر طلب reCAPTCHA المحمي. |
ReCAPTCHAKeyClientType | نوع النظام الأساسي للمفتاح |
ReCAPTCHAProviderforcementState | حالة تنفيذ حماية reCAPTCHA - "إيقاف": غير إلزامي. - "AUDIT": إنشاء تقييم بدون فرض النتيجة - "ENFORCE": إنشاء تقييم وتنفيذ النتيجة |
SmsRegionConfig | واجهة الطلب لتعديل إعدادات منطقة الرسائل القصيرة SMS تحدِّد هذه السياسة المناطق التي يُسمح فيها للمستخدمين بإرسال رسائل قصيرة SMS للتحقّق. يستند ذلك إلى رمز الاتصال الخاص برقم هاتف الوجهة. |
UpdateAuthProviderRequest | |
UpdateMultiFactorInfoRequest | النوع الذي يمثّل خصائص العامل الثاني الذي سجّله المستخدِم في UpdateRequest . |
معرِّف المستخدم | تحدد المستخدم الذي يتم البحث عنه. |
getAuth(app)
تحصل على خدمة المصادقة للتطبيق التلقائي أو لتطبيق معيّن.
يمكن استدعاء getAuth()
بدون وسيطات للوصول إلى خدمة Auth في التطبيق التلقائي أو كـ getAuth(app)
للوصول إلى خدمة Auth المرتبطة بتطبيق محدّد.
Signature:
export declare function getAuth(app?: App): Auth;
المَعلمات
المَعلمة | Type | الوصف |
---|---|---|
التطبيق | التطبيق |
المرتجعات:
مثال 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;
إنشاء طلب توظيف
واجهة تمثّل المواقع المطلوب وضعها على مستأجر جديد.
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';
RecaptchaProviderforcementState
حالة تنفيذ حماية reCAPTCHA - "إيقاف": غير إلزامي. - "AUDIT": إنشاء تقييم بدون فرض النتيجة - "ENFORCE": إنشاء تقييم وتنفيذ النتيجة
Signature:
export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';
إعداد SmsRegionConfig
واجهة الطلب لتعديل إعدادات منطقة الرسائل القصيرة SMS تحدِّد هذه السياسة المناطق التي يُسمح فيها للمستخدمين بإرسال رسائل قصيرة SMS للتحقّق. يستند ذلك إلى رمز الاتصال الخاص برقم هاتف الوجهة.
Signature:
export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;
طلب تحديثAuthProvider
Signature:
export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;
تعديل السياسة المتعدّدة العوامل (UpdateMultiFactorInfoRequest)
تمثّل هذه السمة خصائص العامل الثاني الذي سجّله المستخدم في UpdateRequest
.
Signature:
export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;
معرِّف المستخدم
تحدد المستخدم الذي يتم البحث عنه.
Signature:
export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;