Firebase Rules API

יוצר ומנהל כללים הקובעים מתי שירות המותאם לכללי אבטחה של Firebase צריך לאפשר בקשה.

לתיאור של הכלים שבהם אתה יכול להשתמש כדי לנהל את כללי האבטחה שלך, כולל REST API זה, ראה ניהול ופריסה של כללי אבטחה של Firebase .

סקירה כללית

כללי האבטחה של Firebase מורכבים משפה ומ-API. מפתחים כותבים כללים בשפה, מפרסמים אותם דרך ה-API, ולאחר מכן שולחים בקשות לשירותים התומכים בחוקי אבטחה של Firebase. השירותים מעריכים בקשות באמצעות ערכת הכללים שסופקה וקובעים אם יש לאשר את הבקשות.

המונחים הבאים משמשים בתיעוד התייחסות זה.

  • Source : שפה ספציפית לתחום המכילה כללים בהיקף של service path המתארים את התנאים שבהם ניתן להתיר operation request ספציפית.

  • Ruleset : עותק מתמשך בלתי ניתן לשינוי תוכן Source עם שם שנוצר.

  • Release : הפניה עם שם לערכת Ruleset , אשר הופכת את Ruleset לזמינה לצריכה ואכיפה על ידי שירותים התומכים בחוקי אבטחה של Firebase.

שירות: firebaserules.googleapis.com

כדי להתקשר לשירות זה, אנו ממליצים להשתמש בספריות הלקוחות שסופקו על ידי Google . אם היישום שלך צריך להשתמש בספריות שלך כדי להתקשר לשירות זה, השתמש במידע הבא בעת ביצוע בקשות ה-API.

מסמך גילוי

מסמך Discovery הוא מפרט קריא במכונה לתיאור וצריכת ממשקי API של REST. הוא משמש לבניית ספריות לקוחות, תוספים של IDE וכלים אחרים המקיימים אינטראקציה עם ממשקי API של Google. שירות אחד עשוי לספק מסמכי גילוי מרובים. שירות זה מספק את מסמך הגילוי הבא:

נקודת קצה של שירות

נקודת קצה של שירות היא כתובת 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 .