Firebase Rules API

Cria e gerencia regras que determinam quando um serviço habilitado para Firebase Security Rules deve permitir uma solicitação.

Para obter uma descrição das ferramentas que você pode usar para gerenciar suas regras de segurança, incluindo esta API REST, consulte Gerenciar e implantar regras de segurança do Firebase .

Visão geral

As regras de segurança do Firebase são compostas por uma linguagem e uma API. Os desenvolvedores escrevem regras na linguagem, publicam-nas por meio da API e enviam solicitações para serviços habilitados para Firebase Security Rules. Os serviços avaliam as solicitações usando o conjunto de regras fornecido e determinam se as solicitações devem ser permitidas.

Os seguintes termos são usados ​​nesta documentação de referência.

  • Source : linguagem específica do domínio contendo regras com escopo para um service e path que descreve as condições em que uma operation de request específica pode ser permitida.

  • Ruleset : cópia imutável persistente Conteúdo de Source com um nome gerado.

  • Release : referência nomeada a um conjunto de Ruleset , que disponibiliza o Ruleset de regras para consumo e aplicação por serviços habilitados para regras de segurança do Firebase.

Serviço: firebaserules.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google . Se seu aplicativo precisar usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir ao fazer as solicitações de API.

Documento de descoberta

Um Documento de Descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins de IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço fornece o seguinte documento de descoberta:

Ponto de extremidade de serviço

Um endpoint de serviço é uma URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários terminais de serviço. Este serviço tem o seguinte endpoint de serviço e todos os URIs abaixo são relativos a este endpoint de serviço:

  • https://firebaserules.googleapis.com

Recurso REST: v1.projects

Métodos
test POST /v1/{name=projects/**}:test
Test Source para correção sintática e semântica.

Recurso REST: v1.projects.releases

Métodos
create POST /v1/{name=projects/*}/releases
Crie um Release .
delete DELETE /v1/{name=projects/*/releases/**}
Excluir uma Release pelo nome do recurso.
get GET /v1/{name=projects/*/releases/**}
Obtenha uma Release pelo nome.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Obtenha o executável Release para usar ao impor regras.
list GET /v1/{name=projects/*}/releases
Liste os valores de Release para um projeto.
patch PATCH /v1/{name=projects/*/releases/**}
Atualizar uma Release via PATCH.

Recurso REST: v1.projects.rulesets

Métodos
create POST /v1/{name=projects/*}/rulesets
Crie um Ruleset da Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
Exclua um conjunto de Ruleset pelo nome do recurso.
get GET /v1/{name=projects/*/rulesets/*}
Obtenha um conjunto de Ruleset por nome, incluindo o conteúdo completo da Source .
list GET /v1/{name=projects/*}/rulesets
Liste apenas os metadados do conjunto de Ruleset e, opcionalmente, filtre os resultados pelo nome do conjunto de Ruleset .