Firebase Rules API

Erstellt und verwaltet Regeln, die bestimmen, wann ein Firebase Security Rules-fähiger Dienst eine Anfrage zulassen soll.

Eine Beschreibung der Tools, die Sie zum Verwalten Ihrer Sicherheitsregeln verwenden können, einschließlich dieser REST-API, finden Sie unter Verwalten und Bereitstellen von Firebase-Sicherheitsregeln .

Überblick

Firebase Security Rules besteht aus einer Sprache und einer API. Entwickler schreiben Regeln in der Sprache, veröffentlichen sie über die API und senden dann Anfragen an Dienste, die Firebase Security Rules unterstützen. Dienste bewerten Anfragen anhand des bereitgestellten Regelsatzes und bestimmen, ob die Anfragen zugelassen werden sollen.

In dieser Referenzdokumentation werden die folgenden Begriffe verwendet.

  • Source : Domänenspezifische Sprache mit Regeln für einen service und path operation request sein kann.

  • Ruleset : Persistente, unveränderliche Kopie Source mit einem generierten Namen.

  • Release : Benannter Verweis auf einen Ruleset , der den Ruleset für die Nutzung und Durchsetzung durch Firebase Security Rules-fähige Dienste verfügbar macht.

Dienst: firebaserules.googleapis.com

Um diesen Dienst aufzurufen, empfehlen wir Ihnen, die von Google bereitgestellten Client-Bibliotheken zu verwenden. Wenn Ihre Anwendung zum Aufrufen dieses Dienstes Ihre eigenen Bibliotheken verwenden muss, verwenden Sie die folgenden Informationen, wenn Sie die API-Anfragen stellen.

Entdeckungsdokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zur Beschreibung und Nutzung von REST-APIs. Es wird zum Erstellen von Clientbibliotheken, IDE-Plugins und anderen Tools verwendet, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente bereitstellen. Dieser Dienst stellt das folgende Erkennungsdokument bereit:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst verfügt über den folgenden Dienstendpunkt und alle unten aufgeführten URIs beziehen sich auf diesen Dienstendpunkt:

  • https://firebaserules.googleapis.com

REST-Ressource: v1.projects

Methoden
test POST /v1/{name=projects/**}:test
Source auf syntaktische und semantische Korrektheit.

REST-Ressource: v1.projects.releases

Methoden
create POST /v1/{name=projects/*}/releases
Erstellen Sie eine Release .
delete DELETE /v1/{name=projects/*/releases/**}
Löschen Sie ein Release nach Ressourcennamen.
get GET /v1/{name=projects/*/releases/**}
Holen Sie sich eine Release mit Namen.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Rufen Sie die ausführbare Release Datei ab, die beim Durchsetzen von Regeln verwendet werden soll.
list GET /v1/{name=projects/*}/releases
Listen Sie die Release Werte für ein Projekt auf.
patch PATCH /v1/{name=projects/*/releases/**}
Aktualisieren Sie eine Release über PATCH.

REST-Ressource: v1.projects.rulesets

Methoden
create POST /v1/{name=projects/*}/rulesets
Erstellen Sie einen Ruleset aus Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
Löschen Sie einen Ruleset nach Ressourcennamen.
get GET /v1/{name=projects/*/rulesets/*}
Erhalten Sie einen Ruleset nach Namen, einschließlich des vollständigen Source .
list GET /v1/{name=projects/*}/rulesets
Listen Sie nur Ruleset Metadaten auf und filtern Sie die Ergebnisse optional nach Ruleset .