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.

Документ открытия

Документ обнаружения — это машиночитаемая спецификация для описания и использования REST API. Он используется для создания клиентских библиотек, плагинов 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 .