Firebase Rules API

Crea y administra reglas que determinan cuándo un servicio habilitado para las reglas de seguridad de Firebase debe permitir una solicitud.

Para obtener una descripción de las herramientas que puede usar para administrar sus reglas de seguridad, incluida esta API REST, consulte Administrar e implementar reglas de seguridad de Firebase .

Descripción general

Las reglas de seguridad de Firebase se componen de un lenguaje y una API. Los desarrolladores escriben reglas en el lenguaje, las publican a través de la API y luego envían solicitudes a los servicios habilitados para Firebase Security Rules. Los servicios evalúan las solicitudes utilizando el conjunto de reglas proporcionado y determinan si las solicitudes deben permitirse.

Los siguientes términos se utilizan en esta documentación de referencia.

  • Source : lenguaje específico del dominio que contiene reglas aplicadas a un service y path que describe las condiciones en las que se puede permitir una operation request específica.

  • Ruleset : copia persistente e inmutable Contenido Source con un nombre generado.

  • Release : referencia nombrada a un Ruleset , que hace que el Ruleset esté disponible para su consumo y aplicación por parte de los servicios habilitados para las reglas de seguridad de Firebase.

Servicio: firebaserules.googleapis.com

Para llamar a este servicio, le recomendamos que utilice las bibliotecas cliente proporcionadas por Google. Si su aplicación necesita usar sus propias bibliotecas para llamar a este servicio, use la siguiente información cuando realice las solicitudes de API.

documento de descubrimiento

Un documento de descubrimiento es una especificación legible por máquina para describir y consumir API REST. Se utiliza para crear bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar múltiples documentos de descubrimiento. Este servicio proporciona el siguiente documento de descubrimiento:

Punto final del servicio

Un punto final de servicio es una URL base que especifica la dirección de red de un servicio API. Un servicio puede tener varios puntos finales de servicio. Este servicio tiene el siguiente punto final de servicio y todos los URI siguientes son relativos a este punto final de servicio:

  • https://firebaserules.googleapis.com

Recurso REST: v1.projects

Métodos
test POST /v1/{name=projects/**}:test
Source de prueba para la corrección sintáctica y semántica.

Recurso REST: v1.projects.releases

Métodos
create POST /v1/{name=projects/*}/releases
Crear una Release .
delete DELETE /v1/{name=projects/*/releases/**}
Eliminar una Release por nombre de recurso.
get GET /v1/{name=projects/*/releases/**}
Obtenga una Release por nombre.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Obtenga el ejecutable Release para utilizarlo al aplicar las reglas.
list GET /v1/{name=projects/*}/releases
Enumere los valores Release para un proyecto.
patch PATCH /v1/{name=projects/*/releases/**}
Actualizar una Release mediante PATCH.

Recurso REST: v1.projects.rulesets

Métodos
create POST /v1/{name=projects/*}/rulesets
Crear un Ruleset desde Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
Eliminar un Ruleset por nombre de recurso.
get GET /v1/{name=projects/*/rulesets/*}
Obtenga un Ruleset por nombre, incluido el contenido Source completo.
list GET /v1/{name=projects/*}/rulesets
Enumere solo los metadatos Ruleset y, opcionalmente, filtre los resultados por nombre Ruleset .