Firebase Rules API

Cria e gerencia regras que determinam quando um serviço habilitado para regras de segurança do Firebase 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 aos serviços habilitados para regras de segurança do Firebase. Os serviços avaliam as solicitações usando o conjunto de regras fornecido e determinam se as solicitações devem ser permitidas.

Os termos a seguir 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 quando uma operation request específica pode ser permitida.

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

  • Release : referência nomeada a um Ruleset , que disponibiliza o Ruleset 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 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 construir bibliotecas de clientes, plug-ins IDE e outras ferramentas que interagem com APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço fornece o seguinte documento de descoberta:

Ponto final de serviço

Um terminal 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 terminal de serviço e todos os URIs abaixo são relativos a este terminal de serviço:

  • https://firebaserules.googleapis.com

Recurso REST: v1.projects

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

Recurso REST: v1.projects.releases

Métodos
create POST /v1/{name=projects/*}/releases
Crie uma Release .
delete DELETE /v1/{name=projects/*/releases/**}
Exclua uma Release por nome de recurso.
get GET /v1/{name=projects/*/releases/**}
Obtenha uma Release por 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 Release para um projeto.
patch PATCH /v1/{name=projects/*/releases/**}
Atualize 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 Ruleset por nome de recurso.
get GET /v1/{name=projects/*/rulesets/*}
Obtenha um Ruleset por nome, incluindo o conteúdo completo Source .
list GET /v1/{name=projects/*}/rulesets
Liste apenas os metadados Ruleset e, opcionalmente, filtre os resultados por nome Ruleset .