Firebase Rules API

ينشئ ويدير القواعد التي تحدد متى يجب أن تسمح الخدمة التي تدعم قواعد أمان Firebase بالطلب.

للحصول على وصف للأدوات التي يمكنك استخدامها لإدارة قواعد الأمان لديك، بما في ذلك REST API، راجع إدارة قواعد أمان Firebase ونشرها .

ملخص

تتكون قواعد أمان Firebase من لغة وواجهة برمجة تطبيقات. يكتب المطورون القواعد باللغة، وينشرونها عبر واجهة برمجة التطبيقات (API)، ثم يرسلون الطلبات إلى الخدمات التي تدعم قواعد أمان Firebase. تقوم الخدمات بتقييم الطلبات باستخدام مجموعة القواعد المتوفرة وتحديد ما إذا كان ينبغي السماح بالطلبات.

يتم استخدام المصطلحات التالية في هذه الوثائق المرجعية.

  • Source : لغة خاصة بالمجال تحتوي على قواعد محددة service path يصف الشروط التي قد يُسمح فيها operation request معينة.

  • Ruleset : نسخة ثابتة من محتوى Source مع اسم تم إنشاؤه.

  • Release : مرجع مسمى لمجموعة Ruleset ، مما يجعل Ruleset متاحة للاستهلاك والتنفيذ بواسطة الخدمات التي تدعم قواعد أمان Firebase.

الخدمة: firebaserules.googleapis.com

للاتصال بهذه الخدمة، نوصي باستخدام مكتبات العملاء التي توفرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لاستدعاء هذه الخدمة، فاستخدم المعلومات التالية عند تقديم طلبات واجهة برمجة التطبيقات.

وثيقة الاكتشاف

وثيقة الاكتشاف عبارة عن مواصفات يمكن قراءتها آليًا لوصف واجهات برمجة تطبيقات REST واستهلاكها. يتم استخدامه لإنشاء مكتبات العملاء ومكونات IDE الإضافية والأدوات الأخرى التي تتفاعل مع Google APIs. قد توفر خدمة واحدة مستندات اكتشاف متعددة. توفر هذه الخدمة وثيقة الاكتشاف التالية:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي عنوان URL الأساسي الذي يحدد عنوان الشبكة لخدمة API. قد تحتوي خدمة واحدة على نقاط نهاية خدمة متعددة. تحتوي هذه الخدمة على نقطة نهاية الخدمة التالية وجميع معرفات URI أدناه مرتبطة بنقطة نهاية الخدمة هذه:

  • https://firebaserules.googleapis.com

مصدر الراحة: v1.projects

طُرق
test POST /v1/{name=projects/**}:test
Source اختبار للصحة النحوية والدلالية.

مورد REST: v1.projects.releases

طُرق
create POST /v1/{name=projects/*}/releases
إنشاء Release .
delete DELETE /v1/{name=projects/*/releases/**}
حذف Release حسب اسم المورد.
get GET /v1/{name=projects/*/releases/**}
الحصول على Release بالاسم.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
احصل على Release القابل للتنفيذ لاستخدامه عند فرض القواعد.
list GET /v1/{name=projects/*}/releases
قم بإدراج قيم Release للمشروع.
patch PATCH /v1/{name=projects/*/releases/**}
قم بتحديث Release عبر PATCH.

مورد REST: v1.projects.rulesets

طُرق
create POST /v1/{name=projects/*}/rulesets
إنشاء Ruleset من Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
حذف Ruleset حسب اسم المورد.
get GET /v1/{name=projects/*/rulesets/*}
احصل على Ruleset بالاسم بما في ذلك محتويات Source الكاملة.
list GET /v1/{name=projects/*}/rulesets
قم بإدراج البيانات التعريفية Ruleset فقط وقم بتصفية النتائج اختياريًا حسب اسم Ruleset .