L'interface du service Firebase SecurityRules .
Signature:
export declare class SecurityRules
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| application | Application |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| créer un ensemble de règles (fichier) | Crée un nouvel ensemble de règles à partir du fichier de règles donné . | |
| createRulesFileFromSource(nom, source) | Crée un RulesFile avec le nom et la source donnés. Génère une erreur si l'un des arguments n'est pas valide. Il s'agit d'une opération locale qui n'implique aucun appel d'API réseau. | |
| deleteRuleset(nom) | Supprime l' ensemble de règles identifié par le nom donné. Le nom d'entrée doit être la chaîne de nom courte sans le préfixe de l'ID du projet. Par exemple, pour supprimer le projects/project-id/rulesets/my-ruleset , transmettez le nom court « my-ruleset ». Rejette avec une erreur not-found si l' Ruleset spécifié est introuvable. | |
| getFirestoreRuleset() | Obtient l' ensemble de règles actuellement appliqué à Cloud Firestore. Rejette avec une erreur not-found si aucun ensemble de règles n'est appliqué sur Firestore. | |
| getRuleset(nom) | Obtient l' ensemble de règles identifié par le nom donné. Le nom d'entrée doit être la chaîne de nom courte sans le préfixe de l'ID du projet. Par exemple, pour récupérer le projects/project-id/rulesets/my-ruleset , transmettez le nom court « my-ruleset ». Rejette avec une erreur not-found si l' Ruleset spécifié est introuvable. | |
| getStorageRuleset (seau) | Obtient l' ensemble de règles actuellement appliqué à un bucket Cloud Storage. Rejette avec une erreur not-found si aucun ensemble de règles n'est appliqué sur le compartiment. | |
| listRulesetMetadata(pageSize, nextPageToken) | Récupère une page de métadonnées d’ensemble de règles. | |
| releaseFirestoreRuleset (ensemble de règles) | Applique l'ensemble de règles spécifié à Cloud Firestore. | |
| releaseFirestoreRulesetFromSource(source) | Crée un nouvel ensemble de règles à partir de la source donnée et l'applique à Cloud Firestore. | |
| releaseStorageRuleset (ensemble de règles, compartiment) | Applique l'ensemble de règles d'ensemble de règles spécifié à un bucket Cloud Storage. | |
| releaseStorageRulesetFromSource (source, compartiment) | Crée un nouvel ensemble de règles à partir de la source donnée et l'applique à un bucket Cloud Storage. |
Règles de sécurité.app
Signature:
readonly app: App;
SecurityRules.createRuleset()
Crée un nouvel ensemble de règles à partir du fichier de règles donné .
Signature:
createRuleset(file: RulesFile): Promise<Ruleset>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| déposer | Fichier de règles | Fichier de règles à inclure dans le nouveau Ruleset . |
Retour:
Promesse < Ensemble de règles >
Une promesse qui se réalise avec le nouveau Ruleset .
SecurityRules.createRulesFileFromSource()
Crée un RulesFile avec le nom et la source donnés. Génère une erreur si l'un des arguments n'est pas valide. Il s'agit d'une opération locale qui n'implique aucun appel d'API réseau.
Signature:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Nom à attribuer au fichier de règles. Il s'agit généralement d'un nom de fichier court qui permet d'identifier le fichier dans un ensemble de règles. |
| source | chaîne | Tampon | Contenu du fichier de règles. |
Retour:
Une nouvelle instance de fichier de règles.
Exemple
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
Supprime l' ensemble de règles identifié par le nom donné. Le nom d'entrée doit être la chaîne de nom courte sans le préfixe de l'ID du projet. Par exemple, pour supprimer le projects/project-id/rulesets/my-ruleset , transmettez le nom court "my-ruleset". Rejette avec une erreur not-found si l' Ruleset spécifié est introuvable.
Signature:
deleteRuleset(name: string): Promise<void>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Nom de l' Ruleset à supprimer. |
Retour:
Promesse<vide>
Une promesse qui se réalise lorsque l’ Ruleset est supprimé.
SecurityRules.getFirestoreRuleset()
Obtient l' ensemble de règles actuellement appliqué à Cloud Firestore. Rejette avec une erreur not-found si aucun ensemble de règles n'est appliqué sur Firestore.
Signature:
getFirestoreRuleset(): Promise<Ruleset>;
Retour:
Promesse < Ensemble de règles >
Une promesse qui se réalise avec l'ensemble de règles Firestore.
SecurityRules.getRuleset()
Obtient l' ensemble de règles identifié par le nom donné. Le nom d'entrée doit être la chaîne de nom courte sans le préfixe de l'ID du projet. Par exemple, pour récupérer le projects/project-id/rulesets/my-ruleset , transmettez le nom court "my-ruleset". Rejette avec une erreur not-found si l' Ruleset spécifié est introuvable.
Signature:
getRuleset(name: string): Promise<Ruleset>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Nom de l' Ruleset à récupérer. |
Retour:
Promesse < Ensemble de règles >
Une promesse qui se réalise avec l' Ruleset spécifié .
SecurityRules.getStorageRuleset()
Obtient l' ensemble de règles actuellement appliqué à un bucket Cloud Storage. Rejette avec une erreur not-found si aucun ensemble de règles n'est appliqué sur le compartiment.
Signature:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| seau | chaîne | Nom facultatif du bucket Cloud Storage à récupérer. S'il n'est pas spécifié, récupère l'ensemble de règles appliqué sur le compartiment par défaut configuré via AppOptions . |
Retour:
Promesse < Ensemble de règles >
Une promesse qui se réalise grâce à l'ensemble de règles Cloud Storage.
SecurityRules.listRulesetMetadata()
Récupère une page de métadonnées d’ensemble de règles.
Signature:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| taille de la page | nombre | La taille de la page, 100 si non définie. C'est également la limite maximale autorisée. |
| jetonPage suivante | chaîne | Le jeton de la page suivante. S'il n'est pas spécifié, renvoie les ensembles de règles commençant sans aucun décalage. |
Retour:
Promesse < RulesetMetadataList >
Une promesse qui se réalise avec une page de règles.
SecurityRules.releaseFirestoreRuleset()
Applique l'ensemble de règles spécifié à Cloud Firestore.
Signature:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| ensemble de règles | chaîne | Ensemble de règlesMétadonnées | Nom de l'ensemble de règles à appliquer ou un objet RulesetMetadata contenant le nom. |
Retour:
Promesse<vide>
Une promesse qui se réalisera lorsque les règles seront publiées.
SecurityRules.releaseFirestoreRulesetFromSource()
Crée un nouvel ensemble de règles à partir de la source donnée et l'applique à Cloud Firestore.
Signature:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| source | chaîne | Tampon | Source des règles à appliquer. |
Retour:
Promesse < Ensemble de règles >
Une promesse qui se réalise lorsque l’ensemble de règles est créé et publié.
SecurityRules.releaseStorageRuleset()
Applique l'ensemble de règles d'ensemble de règles spécifié à un bucket Cloud Storage.
Signature:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| ensemble de règles | chaîne | Ensemble de règlesMétadonnées | Nom de l'ensemble de règles à appliquer ou un objet RulesetMetadata contenant le nom. |
| seau | chaîne | Nom facultatif du bucket Cloud Storage sur lequel appliquer les règles. S'il n'est pas spécifié, applique l'ensemble de règles sur le compartiment par défaut configuré via AppOptions. . |
Retour:
Promesse<vide>
Une promesse qui se réalisera lorsque les règles seront publiées.
SecurityRules.releaseStorageRulesetFromSource()
Crée un nouvel ensemble de règles à partir de la source donnée et l'applique à un bucket Cloud Storage.
Signature:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| source | chaîne | Tampon | Source des règles à appliquer. |
| seau | chaîne | Nom facultatif du bucket Cloud Storage sur lequel appliquer les règles. S'il n'est pas spécifié, applique l'ensemble de règles sur le compartiment par défaut configuré via AppOptions. . |
Retour:
Promesse < Ensemble de règles >
Une promesse qui se réalise lorsque l’ensemble de règles est créé et publié.