Firebase Rules API

Firebase Güvenlik Kuralları'nın etkin olduğu bir hizmetin bir isteğe ne zaman izin vermesi gerektiğini belirleyen kurallar oluşturur ve yönetir.

Bu REST API dahil Güvenlik Kurallarınızı yönetmek için kullanabileceğiniz araçların açıklaması için bkz . Firebase Güvenlik Kurallarını Yönetme ve dağıtma .

Genel Bakış

Firebase Güvenlik Kuralları bir dil ve bir API'den oluşur. Geliştiriciler bu dilde kurallar yazar, bunları API aracılığıyla yayınlar ve ardından istekleri Firebase Güvenlik Kuralları'nın etkin olduğu hizmetlere gönderir. Hizmetler, sağlanan kural kümesini kullanarak istekleri değerlendirir ve isteklere izin verilip verilmeyeceğini belirler.

Bu referans belgelerinde aşağıdaki terimler kullanılmaktadır.

  • Source : Belirli bir request operation izin verilebileceği koşulları açıklayan bir service ve path yönelik kuralları içeren, etki alanına özgü dil.

  • Ruleset : Oluşturulan bir adla kalıcı, değişmez kopya Source içeriği.

  • Release : Ruleset Firebase Güvenlik Kurallarının etkin olduğu hizmetler tarafından tüketime ve uygulamaya uygun hale getiren bir Ruleset yönelik adlandırılmış referans.

Hizmet: firebaserules.googleapis.com

Bu hizmeti çağırmak için Google tarafından sağlanan istemci kitaplıklarını kullanmanızı öneririz. Uygulamanızın bu hizmeti çağırmak için kendi kitaplıklarınızı kullanması gerekiyorsa API isteklerini yaparken aşağıdaki bilgileri kullanın.

Keşif belgesi

Keşif Belgesi, REST API'lerini tanımlamak ve tüketmek için makine tarafından okunabilen bir spesifikasyondur. İstemci kitaplıkları, IDE eklentileri ve Google API'leriyle etkileşime giren diğer araçları oluşturmak için kullanılır. Bir hizmet birden fazla keşif belgesi sağlayabilir. Bu hizmet aşağıdaki keşif belgesini sağlar:

Hizmet uç noktası

Hizmet uç noktası, bir API hizmetinin ağ adresini belirten bir temel URL'dir. Bir hizmetin birden fazla hizmet uç noktası olabilir. Bu hizmet aşağıdaki hizmet uç noktasına sahiptir ve aşağıdaki tüm URI'ler bu hizmet uç noktasına göredir:

  • https://firebaserules.googleapis.com

REST Kaynağı: v1.projects

Yöntemler
test POST /v1/{name=projects/**}:test
Sözdizimsel ve anlamsal doğruluk için Test Source .

REST Kaynağı: v1.projects.releases

Yöntemler
create POST /v1/{name=projects/*}/releases
Bir Release Oluşturun.
delete DELETE /v1/{name=projects/*/releases/**}
Kaynak adına göre bir Release silin.
get GET /v1/{name=projects/*/releases/**}
Ada göre bir Release alın.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Kuralları uygularken kullanılacak Release yürütülebilir dosyasını edinin.
list GET /v1/{name=projects/*}/releases
Bir projenin Release değerlerini listeleyin.
patch PATCH /v1/{name=projects/*/releases/**}
Bir Release PATCH aracılığıyla güncelleyin.

REST Kaynağı: v1.projects.rulesets

Yöntemler
create POST /v1/{name=projects/*}/rulesets
Source bir Ruleset oluşturun.
delete DELETE /v1/{name=projects/*/rulesets/*}
Kaynak adına göre bir Ruleset silin.
get GET /v1/{name=projects/*/rulesets/*}
Tam Source içeriğini içeren ada göre bir Ruleset edinin.
list GET /v1/{name=projects/*}/rulesets
Yalnızca Ruleset meta verilerini listeleyin ve isteğe bağlı olarak sonuçları Ruleset adına göre filtreleyin.