The FirebaseSecurityRules service interface.

Signature:

exportdeclareclassSecurityRules

Properties

Methods

SecurityRules.app

Signature:

readonlyapp:App;

SecurityRules.createRuleset()

Creates a newRuleset from the givenRulesFile.

Signature:

createRuleset(file:RulesFile):Promise<Ruleset>;

Parameters

Returns:

Promise<Ruleset>

A promise that fulfills with the newly createdRuleset.

SecurityRules.createRulesFileFromSource()

Creates aRulesFile with the given name and source. Throws an error if any of the arguments are invalid. This is a local operation, and does not involve any network API calls.

Signature:

createRulesFileFromSource(name:string,source:string|Buffer):RulesFile;

Parameters

Returns:

RulesFile

A new rules file instance.

Example

constsource='// Some rules source';construlesFile=admin.securityRules().createRulesFileFromSource('firestore.rules',source);

SecurityRules.deleteRuleset()

Deletes theRuleset identified by the given name. The input name should be the short name string without the project ID prefix. For example, to delete theprojects/project-id/rulesets/my-ruleset, pass the short name "my-ruleset". Rejects with anot-found error if the specifiedRuleset cannot be found.

Signature:

deleteRuleset(name:string):Promise<void>;

Parameters

Returns:

Promise<void>

A promise that fulfills when theRuleset is deleted.

SecurityRules.getFirestoreRuleset()

Gets theRuleset currently applied to Cloud Firestore. Rejects with anot-found error if no ruleset is applied on Firestore.

Signature:

getFirestoreRuleset():Promise<Ruleset>;

Returns:

Promise<Ruleset>

A promise that fulfills with the Firestore ruleset.

SecurityRules.getRuleset()

Gets theRuleset identified by the given name. The input name should be the short name string without the project ID prefix. For example, to retrieve theprojects/project-id/rulesets/my-ruleset, pass the short name "my-ruleset". Rejects with anot-found error if the specifiedRuleset cannot be found.

Signature:

getRuleset(name:string):Promise<Ruleset>;

Parameters

Returns:

Promise<Ruleset>

A promise that fulfills with the specifiedRuleset.

SecurityRules.getStorageRuleset()

Gets theRuleset currently applied to a Cloud Storage bucket. Rejects with anot-found error if no ruleset is applied on the bucket.

Signature:

getStorageRuleset(bucket?:string):Promise<Ruleset>;

Parameters

Returns:

Promise<Ruleset>

A promise that fulfills with the Cloud Storage ruleset.

SecurityRules.listRulesetMetadata()

Retrieves a page of ruleset metadata.

Signature:

listRulesetMetadata(pageSize?:number,nextPageToken?:string):Promise<RulesetMetadataList>;

Parameters

Returns:

Promise<RulesetMetadataList>

A promise that fulfills with a page of rulesets.

SecurityRules.releaseFirestoreRuleset()

Applies the specifiedRuleset ruleset to Cloud Firestore.

Signature:

releaseFirestoreRuleset(ruleset:string|RulesetMetadata):Promise<void>;

Parameters

Returns:

Promise<void>

A promise that fulfills when the ruleset is released.

SecurityRules.releaseFirestoreRulesetFromSource()

Creates a newRuleset from the given source, and applies it to Cloud Firestore.

Signature:

releaseFirestoreRulesetFromSource(source:string|Buffer):Promise<Ruleset>;

Parameters

Returns:

Promise<Ruleset>

A promise that fulfills when the ruleset is created and released.

SecurityRules.releaseStorageRuleset()

Applies the specifiedRuleset ruleset to a Cloud Storage bucket.

Signature:

releaseStorageRuleset(ruleset:string|RulesetMetadata,bucket?:string):Promise<void>;

Parameters

Returns:

Promise<void>

A promise that fulfills when the ruleset is released.

SecurityRules.releaseStorageRulesetFromSource()

Creates a newRuleset from the given source, and applies it to a Cloud Storage bucket.

Signature:

releaseStorageRulesetFromSource(source:string|Buffer,bucket?:string):Promise<Ruleset>;

Parameters

Returns:

Promise<Ruleset>

A promise that fulfills when the ruleset is created and released.