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 .

Visión general

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

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

  • Source : Lenguaje específico del dominio que contiene reglas en el ámbito de un service y una path que describe las condiciones en las que se puede permitir una operation de request específica.

  • Ruleset de reglas: contenido de Source de copia inmutable persistente con un nombre generado.

  • Release : referencia con nombre a un conjunto de Ruleset , que hace que el conjunto de Ruleset esté disponible para el consumo y la 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 de clientes, 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 de 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 múltiples puntos finales de servicio. Este servicio tiene el siguiente punto final de servicio y todos los URI a continuación son relativos a este punto final de servicio:

  • https://firebaserules.googleapis.com

Recurso REST: v1.proyectos

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 un Release .
delete DELETE /v1/{name=projects/*/releases/**}
Eliminar una Release por nombre de recurso.
get GET /v1/{name=projects/*/releases/**}
Obtener un Release por nombre.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Obtenga el ejecutable Release para usarlo al hacer cumplir las reglas.
list GET /v1/{name=projects/*}/releases
Enumere los valores de Release para un proyecto.
patch PATCH /v1/{name=projects/*/releases/**}
Actualizar una Release a través de PATCH.

Recurso REST: v1.projects.rulesets

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