SecurityRules class

A interface de serviço SecurityRules do Firebase.

Assinatura:

export declare class SecurityRules 

Propriedades

Métodos

SecurityRules.app

Assinatura:

readonly app: App;

SecurityRules.createRuleset()

Cria um novo Ruleset do RulesFile especificado.

Assinatura:

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

Parâmetros

Retorna:

Promessa<Conjunto de regras>

Uma promessa que é cumprida com a recém-criada Ruleset.

SecurityRules.createRulesFileFromSource()

Cria um RulesFile com o nome e a origem fornecidos. Um erro será exibido se algum dos argumentos for inválido. Essa é uma operação local e não envolve chamadas de API de rede.

Assinatura:

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

Parâmetros

Retorna:

RulesFile (link em inglês)

Uma nova instância de arquivo de regras.

Exemplo

const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
  'firestore.rules', source);

SecurityRules.deleteRuleset()

Exclui o Conjunto de regras identificado pelo nome fornecido. O nome da entrada precisa ser a string de nome curta sem o prefixo do ID do projeto. Por exemplo, para excluir a projects/project-id/rulesets/my-ruleset, transmita o nome curto "my-ruleset". Rejeita com um erro not-found se o Ruleset especificado não puder ser encontrado.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma promessa que será atendida quando a Ruleset for excluída.

SecurityRules.getFirestoreRuleset()

Recebe o Conjunto de regras atualmente aplicado ao Cloud Firestore. Rejeita com um erro not-found se nenhum conjunto de regras for aplicado no Firestore.

Assinatura:

getFirestoreRuleset(): Promise<Ruleset>;

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida com o conjunto de regras do Firestore.

SecurityRules.getRuleset()

Recebe o Ruleset identificado pelo nome fornecido. O nome da entrada precisa ser a string de nome curta sem o prefixo do ID do projeto. Por exemplo, para recuperar a projects/project-id/rulesets/my-ruleset, transmita o nome curto "my-ruleset". Rejeita com um erro not-found se o Ruleset especificado não puder ser encontrado.

Assinatura:

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

Parâmetros

Retorna:

Promessa<Conjunto de regras>

Uma promessa que é atendida com o Ruleset especificado.

SecurityRules.getStorageRuleset()

Recebe o Conjunto de regras atualmente aplicado a um bucket do Cloud Storage. Rejeita com um erro not-found se nenhum conjunto de regras for aplicado no bucket.

Assinatura:

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

Parâmetros

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida com o conjunto de regras do Cloud Storage.

SecurityRules.listRulesetMetadata()

Recupera uma página de metadados do conjunto de regras.

Assinatura:

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

Parâmetros

Retorna:

Promessa<RulesetMetadataList>

Uma promessa que é atendida com uma página de conjuntos de regras.

SecurityRules.releaseFirestoreRuleset()

Aplica o conjunto de regras Ruleset especificado ao Cloud Firestore.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma promessa que será atendida quando o conjunto de regras for liberado.

SecurityRules.releaseFirestoreRulesetFromSource()

Cria um novo Ruleset da origem especificada e o aplica ao Cloud Firestore.

Assinatura:

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

Parâmetros

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida quando o conjunto de regras for criado e liberado.

SecurityRules.releaseStorageRuleset()

Aplica o conjunto de regras Ruleset especificado a um bucket do Cloud Storage.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma promessa que será atendida quando o conjunto de regras for liberado.

SecurityRules.releaseStorageRulesetFromSource()

Cria um novo Conjunto de regras a partir da origem especificada e o aplica a um bucket do Cloud Storage.

Assinatura:

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

Parâmetros

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida quando o conjunto de regras for criado e liberado.