Firebase Rules API

Tworzy reguły określające, kiedy usługa obsługująca reguły zabezpieczeń Firebase powinna zezwalać na żądanie i zarządza nimi.

Aby zapoznać się z opisem narzędzi, których możesz użyć do zarządzania regułami bezpieczeństwa, w tym tym interfejsem API REST, zobacz Zarządzanie i wdrażanie reguł bezpieczeństwa Firebase .

Przegląd

Reguły bezpieczeństwa Firebase składają się z języka i interfejsu API. Programiści piszą reguły w tym języku, publikują je za pośrednictwem interfejsu API, a następnie przesyłają żądania do usług obsługujących reguły bezpieczeństwa Firebase. Usługi oceniają żądania przy użyciu dostarczonego zestawu reguł i określają, czy żądania powinny być dozwolone.

W niniejszej dokumentacji referencyjnej używane są następujące terminy.

  • Source : język specyficzny dla domeny zawierający reguły dotyczące service i path opisującej warunki, w których może być dozwolona określona operation request .

  • Ruleset : trwała, niezmienna kopia. Source treści z wygenerowaną nazwą.

  • Release : nazwane odniesienie do zestawu Ruleset , które udostępnia Ruleset do wykorzystania i egzekwowania przez usługi obsługujące reguły zabezpieczeń Firebase.

Usługa: firebaserules.googleapis.com

Aby wywołać tę usługę, zalecamy skorzystanie z bibliotek klienckich dostarczonych przez Google. Jeśli Twoja aplikacja musi korzystać z własnych bibliotek do wywoływania tej usługi, podczas wysyłania żądań do interfejsu API użyj poniższych informacji.

Dokument odkrycia

Dokument odkrycia to czytelna maszynowo specyfikacja opisująca i korzystająca z interfejsów API REST. Służy do budowania bibliotek klienckich, wtyczek IDE i innych narzędzi współdziałających z interfejsami API Google. Jedna usługa może udostępniać wiele dokumentów wykrywania. Ta usługa zapewnia następujący dokument odkrycia:

Punkt końcowy usługi

Punkt końcowy usługi to podstawowy adres URL określający adres sieciowy usługi API. Jedna usługa może mieć wiele punktów końcowych usługi. Ta usługa ma następujący punkt końcowy usługi i wszystkie poniższe identyfikatory URI odnoszą się do tego punktu końcowego usługi:

  • https://firebaserules.googleapis.com

Zasób REST: v1.projects

Metody
test POST /v1/{name=projects/**}:test
Source testowe pod kątem poprawności składniowej i semantycznej.

Zasób REST: v1.projects.releases

Metody
create POST /v1/{name=projects/*}/releases
Utwórz Release .
delete DELETE /v1/{name=projects/*/releases/**}
Usuń Release według nazwy zasobu.
get GET /v1/{name=projects/*/releases/**}
Zdobądź Release według nazwy.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Pobierz plik wykonywalny Release , który będzie używany podczas egzekwowania reguł.
list GET /v1/{name=projects/*}/releases
Wyświetl wartości Release dla projektu.
patch PATCH /v1/{name=projects/*/releases/**}
Zaktualizuj Release poprzez PATCH.

Zasób REST: v1.projects.rulesets

Metody
create POST /v1/{name=projects/*}/rulesets
Utwórz Ruleset ze Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
Usuń Ruleset według nazwy zasobu.
get GET /v1/{name=projects/*/rulesets/*}
Uzyskaj Ruleset według nazwy, zawierający pełną zawartość Source .
list GET /v1/{name=projects/*}/rulesets
Wyświetl tylko metadane Ruleset i opcjonalnie przefiltruj wyniki według nazwy Ruleset .