firebase-admin.security-rules package

Regras de segurança para o Cloud Firestore e o Cloud Storage.

Funções

Função Descrição
getSecurityRules(app) (link em inglês) Recebe o serviço SecurityRules para o app padrão ou para um determinado app.O método admin.securityRules() pode ser chamado sem argumentos para acessar o serviço SecurityRules do app padrão ou como admin.securityRules(app) para acessar o serviço SecurityRules associado a um app específico.

Classes

Turma Descrição
Conjunto de regras Um conjunto de regras de segurança do Firebase.
RulesetMetadataList (em inglês) Uma página de metadados do conjunto de regras.
SecurityRules (link em inglês) A interface de serviço SecurityRules do Firebase.

Interfaces

Interface Descrição
RulesetMetadata (em inglês) Metadados obrigatórios associados a um conjunto de regras.
RulesFile (link em inglês) Um arquivo de origem que contém algumas regras de segurança do Firebase. O conteúdo inclui o código-fonte bruto, incluindo formatação de texto, recuo e comentários. Use o método SecurityRules.createRulesFileFromSource() para criar novas instâncias desse tipo.

getSecurityRules(app)

Recebe o serviço SecurityRules para o app padrão ou um determinado app.

O admin.securityRules() pode ser chamado sem argumentos para acessar o serviço SecurityRules do app padrão ou como admin.securityRules(app) para acessar o serviço SecurityRules associado a um app específico.

Assinatura:

export declare function getSecurityRules(app?: App): SecurityRules;

Parâmetros

Parâmetro Tipo Descrição
app App App opcional para retornar o serviço SecurityRules. Se não for informado, o serviço SecurityRules padrão será retornado.

Retorna:

SecurityRules (link em inglês)

O serviço SecurityRules padrão, se nenhum app for fornecido, ou o serviço SecurityRules associado ao app fornecido.

Exemplo 1

// Get the SecurityRules service for the default app
const defaultSecurityRules = getSecurityRules();

Exemplo 2

// Get the SecurityRules service for a given app
const otherSecurityRules = getSecurityRules(otherApp);