Firebase Rules API

Crée et gère des règles qui déterminent quand un service compatible avec les règles de sécurité Firebase doit autoriser une demande.

Pour une description des outils que vous pouvez utiliser pour gérer vos règles de sécurité, y compris cette API REST, consultez Gérer et déployer les règles de sécurité Firebase .

Aperçu

Les règles de sécurité Firebase comprennent un langage et une API. Les développeurs écrivent des règles dans le langage, les publient via l'API, puis soumettent des requêtes aux services compatibles avec les règles de sécurité Firebase. Les services évaluent les demandes à l'aide de l'ensemble de règles fourni et déterminent si les demandes doivent être autorisées.

Les termes suivants sont utilisés dans cette documentation de référence.

  • Source : langage spécifique au domaine contenant des règles étendues à un service et path décrivant les conditions dans lesquelles une operation request spécifique peut être autorisée.

  • Ruleset : Copie persistante et immuable Contenu Source avec un nom généré.

  • Release : référence nommée à un Ruleset , qui rend l' Ruleset disponible pour la consommation et l'application par les services compatibles avec les règles de sécurité Firebase.

Service : firebaserules.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, utilisez les informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification lisible par machine permettant de décrire et d'utiliser les API REST. Il est utilisé pour créer des bibliothèques clientes, des plugins IDE et d'autres outils qui interagissent avec les API Google. Un service peut fournir plusieurs documents de découverte. Ce service fournit le document de découverte suivant :

Point de terminaison du service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service API. Un service peut avoir plusieurs points de terminaison de service. Ce service a le point de terminaison de service suivant et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://firebaserules.googleapis.com

Ressource REST : v1.projects

Méthodes
test POST /v1/{name=projects/**}:test
Testez Source pour l’exactitude syntaxique et sémantique.

Ressource REST : v1.projects.releases

Méthodes
create POST /v1/{name=projects/*}/releases
Créez une Release .
delete DELETE /v1/{name=projects/*/releases/**}
Supprimez une Release par nom de ressource.
get GET /v1/{name=projects/*/releases/**}
Obtenez une Release par nom.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Obtenez l’exécutable Release à utiliser lors de l’application des règles.
list GET /v1/{name=projects/*}/releases
Répertoriez les valeurs Release pour un projet.
patch PATCH /v1/{name=projects/*/releases/**}
Mettre à jour une Release via PATCH.

Ressource REST : v1.projects.rulesets

Méthodes
create POST /v1/{name=projects/*}/rulesets
Créez un Ruleset à partir de Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
Supprimez un Ruleset par nom de ressource.
get GET /v1/{name=projects/*/rulesets/*}
Obtenez un Ruleset par nom comprenant le contenu complet Source .
list GET /v1/{name=projects/*}/rulesets
Répertoriez uniquement les métadonnées Ruleset et filtrez éventuellement les résultats par nom Ruleset .