firebase-admin.security-rules package

Regras de segurança do Cloud Firestore e do Cloud Storage.

Funções

Função Descrição
getSecurityRules(app) (em inglês) Recebe o serviço SecurityRules do app padrão ou de um determinado app.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.

Aulas

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

Interfaces

Interface Descrição
RulesetMetadata (link em inglês) Metadados obrigatórios associados a um conjunto de regras.
RulesFile Um arquivo de origem que contém algumas regras de segurança do Firebase. O conteúdo inclui 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 o qual o serviço SecurityRules será retornado. Caso não seja fornecido, 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);