建立和管理規則,以確定啟用 Firebase 安全規則的服務何時應允許請求。
有關可用於管理安全性規則的工具(包括此 REST API)的說明,請參閱管理和部署 Firebase 安全性規則。
概述
Firebase 安全性規則由語言和 API 組成。開發人員用該語言編寫規則,透過 API 發布它們,然後向支援 Firebase 安全規則的服務提交請求。服務使用提供的規則集評估請求並確定是否應允許該請求。
本參考文檔中使用了以下術語。
Source
:特定於網域的語言,包含service
內的規則和描述允許特定request
operation
時的條件的path
。Ruleset
:具有產生名稱的持久性不可變副本Source
內容。Release
:Ruleset
的命名引用,使Ruleset
可供支援 Firebase 安全性規則的服務使用和執行。
服務:firebaserules.googleapis.com
若要呼叫此服務,我們建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用您自己的程式庫來呼叫此服務,請在發出 API 請求時使用以下資訊。
發現文件
發現文件是用於描述和使用 REST API 的機器可讀規格。它用於建立客戶端庫、IDE 插件以及與 Google API 互動的其他工具。一項服務可能會提供多個發現文件。該服務提供以下發現文件:
服務端點
服務端點是指定 API 服務的網路位址的基本 URL。一項服務可能有多個服務端點。本服務具有以下服務端點,且以下所有 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/**} 透過 PATCH 更新 Release 。 |
REST 資源: v1.projects.rulesets
方法 | |
---|---|
create | POST /v1/{name=projects/*}/rulesets 從 Source 建立Ruleset 。 |
delete | DELETE /v1/{name=projects/*/rulesets/*} 按資源名稱刪除 Ruleset 。 |
get | GET /v1/{name=projects/*/rulesets/*} 按名稱取得 Ruleset ,包括完整的Source 內容。 |
list | GET /v1/{name=projects/*}/rulesets 僅列出 Ruleset 集元數據,並可選擇依Ruleset 集名稱篩選結果。 |