Firebase Rules API

قوانینی را ایجاد و مدیریت می‌کند که تعیین می‌کنند سرویس‌های دارای قوانین امنیتی Firebase چه زمانی باید به درخواست اجازه دهند.

برای توضیح ابزارهایی که می توانید برای مدیریت قوانین امنیتی خود از جمله این API REST استفاده کنید، به مدیریت و استقرار قوانین امنیتی Firebase مراجعه کنید.

بررسی اجمالی

قوانین امنیتی Firebase از یک زبان و یک API تشکیل شده است. توسعه دهندگان قوانین را به زبان می نویسند، آنها را از طریق API منتشر می کنند و سپس درخواست ها را به سرویس های دارای قواعد امنیتی Firebase ارسال می کنند. سرویس ها درخواست ها را با استفاده از مجموعه قوانین ارائه شده ارزیابی می کنند و تعیین می کنند که آیا درخواست ها باید مجاز باشند یا خیر.

عبارات زیر در این مستندات مرجع استفاده می شود.

  • Source : زبان مخصوص دامنه حاوی قوانینی است که محدوده یک service و path را توصیف می کند که شرایطی را که ممکن است یک operation request خاص مجاز باشد، توصیف می کند.

  • Ruleset : کپی ثابت و تغییرناپذیر محتوای Source با نام تولید شده.

  • Release : مرجع نامگذاری شده به یک Ruleset ، که Ruleset برای مصرف و اجرا توسط سرویس‌های دارای قوانین امنیتی Firebase در دسترس قرار می‌دهد.

خدمات: firebaserules.googleapis.com

برای تماس با این سرویس، توصیه می کنیم از کتابخانه های سرویس گیرنده ارائه شده توسط Google استفاده کنید. اگر برنامه شما نیاز به استفاده از کتابخانه های خود برای فراخوانی این سرویس دارد، هنگام درخواست API از اطلاعات زیر استفاده کنید.

سند کشف

Discovery Document یک ویژگی قابل خواندن توسط ماشین برای توصیف و مصرف API های REST است. از آن برای ساخت کتابخانه های سرویس گیرنده، پلاگین های IDE و سایر ابزارهایی که با Google API در تعامل هستند استفاده می شود. یک سرویس ممکن است چندین سند کشف را ارائه دهد. این سرویس سند کشف زیر را ارائه می دهد:

نقطه پایان خدمات

نقطه پایانی سرویس یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و همه URI های زیر مربوط به این نقطه پایانی سرویس هستند:

  • https://firebaserules.googleapis.com

منبع REST: 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 فیلتر کنید.