Save the date for Firebase Demo Day 2024. Learn how to build and run modern, AI-powered apps users love. Learn more.

Esta página foi traduzida pela API Cloud Translation.

firebase-admin.auth package

Autenticação Firebase.

Funções

Função	Descrição
getAuth(aplicativo)	Obtém o serviço Auth para o aplicativo padrão ou um determinado aplicativo. `getAuth()` pode ser chamado sem argumentos para acessar o serviço Auth do aplicativo padrão ou como `getAuth(app)` para acessar o serviço Auth associado a um aplicativo específico.

Aulas

Aula	Descrição
Autenticação	Serviço de autenticação vinculado ao aplicativo fornecido. Uma instância Auth pode ter vários locatários.
BaseAuth	Interface pai comum para APIs `Auth` e `TenantAwareAuth` .
MultiFactorInfo	Interface que representa as propriedades comuns de um segundo fator registrado pelo usuário.
Configurações MultiFactor	As configurações do usuário relacionadas a vários fatores.
TelefoneMultiFactorInfo	Interface que representa um segundo fator registrado pelo usuário específico do telefone.
Configuração do projeto	Representa uma configuração de projeto.
ProjectConfigManager	Gerencia (obtém e atualiza) a configuração atual do projeto.
Inquilino	Representa uma configuração de locatário. O suporte para multilocação requer a plataforma de identidade do Google Cloud (GCIP). Para saber mais sobre o GCIP, incluindo preços e recursos, consulte a documentação do GCIP . Antes que a multilocação possa ser usada em um projeto do Google Cloud Identity Platform, os locatários precisam ter permissão nesse projeto por meio da IU do Console do Cloud. Uma configuração de locatário fornece informações como nome de exibição, identificador de locatário e configuração de autenticação de email. Para o gerenciamento de configuração do provedor OIDC/SAML, as instâncias `TenantAwareAuth` devem ser usadas em vez de um `Tenant` para recuperar a lista de IdPs configurados em um locatário. Ao configurar esses provedores, observe que os locatários herdarão domínios na lista de permissões e URIs de redirecionamento autenticados do projeto pai. Todas as outras configurações de um locatário também serão herdadas. Eles precisarão ser gerenciados na IU do Cloud Console.
TenantAwareAuth	Interface `Auth` com reconhecimento de locatário usada para gerenciar usuários, configurar provedores SAML/OIDC, gerar links de e-mail para redefinição de senha, verificação de e-mail, etc. para locatários específicos. O suporte para multilocação requer a plataforma de identidade do Google Cloud (GCIP). Para saber mais sobre o GCIP, incluindo preços e recursos, consulte a documentação do GCIP . Cada locatário contém seus próprios provedores de identidade, configurações e conjuntos de usuários. Usando `TenantAwareAuth` , os usuários de um locatário específico e as configurações OIDC/SAML correspondentes também podem ser gerenciados, os tokens de ID para usuários conectados a um locatário específico podem ser verificados e links de ação de email também podem ser gerados para usuários pertencentes ao locatário. Instâncias `TenantAwareAuth` para um `tenantId` específico podem ser instanciadas chamando TenantManager.authForTenant() .
Gerente de Inquilino	Define o gerenciador de locatários usado para ajudar a gerenciar operações relacionadas a locatários. Isso inclui: A capacidade de criar, atualizar, listar, obter e excluir locatários do projeto subjacente. Obter uma instância `TenantAwareAuth` para executar operações relacionadas ao Auth (gerenciamento de usuários, gerenciamento de configuração do provedor, verificação de token, geração de link de e-mail, etc.) no contexto de um locatário especificado.
Informação de usuário	Representa as informações de um usuário de um provedor de identidade terceirizado, como Google ou Facebook.
UserMetadados	Representa os metadados de um usuário.
Registro do usuário	Representa um usuário.

Interfaces

Interface	Descrição
Configurações de ActionCode	Esta é a interface que define o URL de continuação/estado necessário com identificadores de pacote Android e iOS opcionais.
Permitir por padrão	Define uma política de permissão de todas as regiões por padrão e adição de regiões não permitidas a uma lista de proibições.
AllowByDefaultWrap	Configuração de região SMS exclusiva mútua da interface AllowByDefault
Somente lista de permissões	Define uma política de permitir apenas regiões adicionando-as explicitamente a uma lista de permissões.
Lista de permissõesOnlyWrap	Configuração de região SMS mutuamente exclusiva da interface AllowlistOnly
AuthProviderConfigFilter	A interface de filtro usada para listar configurações do provedor. Isso é usado ao especificar como listar provedores de identidade configurados via BaseAuth.listProviderConfigs() .
BaseAuthProviderConfig	A interface de configuração do provedor de autenticação base.
BaseCreateMultiFactorInfoRequest	Interface que representa as propriedades base de um segundo fator registrado pelo usuário para um `CreateRequest` .
BaseUpdateMultiFactorInfoRequest	Interface que representa propriedades comuns de um segundo fator registrado pelo usuário para um `UpdateRequest` .
CreatePhoneMultiFactorInfoRequest	Interface que representa um segundo fator registrado pelo usuário específico do telefone para um `CreateRequest` .
Criar solicitação	Interface que representa as propriedades a serem definidas em um novo registro de usuário a ser criado.
CustomStrengthOptionsConfig	Restrições a serem aplicadas na política de senha
DecodificadoIdToken	Interface que representa um token de ID do Firebase decodificado, retornado do método BaseAuth.verifyIdToken() . Os tokens de ID do Firebase são JSON Web Tokens (JWTs) compatíveis com as especificações do OpenID Connect. Consulte a [seção ID Token da especificação OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) para obter mais informações sobre as propriedades específicas abaixo.
ExcluirUsersResult	Representa o resultado do BaseAuth.deleteUsers() . API.
Identificador de e-mail	Usado para procurar uma conta por e-mail. Consulte BaseAuth.getUsers() .
EmailPrivacyConfig	A configuração de privacidade de email de um projeto ou locatário.
EmailSignInProviderConfig	A configuração do provedor de login de e-mail.
GetUsersResult	Representa o resultado da API BaseAuth.getUsers() .
ListProviderConfigResults	A interface de resposta para listar as configurações do provedor. Isto só está disponível ao listar todas as configurações dos provedores de identidade via BaseAuth.listProviderConfigs() .
ListaInquilinosResultado	Interface que representa o objeto retornado de uma operação TenantManager.listTenants() . Contém a lista de locatários do lote atual e o token da próxima página, se disponível.
ListUsersResult	Interface que representa o objeto retornado de uma operação BaseAuth.listUsers() . Contém a lista de usuários do lote atual e o token da próxima página, se disponível.
MultiFactorConfig	Interface representando uma configuração multifator. Isso pode ser usado para definir se a autenticação multifator está habilitada ou desabilitada e a lista de desafios de segundo fator que são suportados.
MultiFactorCreateSettings	As configurações de usuário relacionadas a vários fatores para operações de criação.
MultiFactorProviderConfig	Interface que representa uma configuração de provedor de autenticação multifator. Essa interface é usada para provedores de autenticação de segundo fator que não sejam SMS. Atualmente, apenas o TOTP é compatível.
Configurações de atualização do MultiFactor	As configurações de usuário relacionadas a vários fatores para operações de atualização.
OAuthResponseType	A interface que representa o objeto de resposta do provedor OIDC para o fluxo de autorização OAuth. Uma das seguintes configurações é necessária: Defina `code` como `true` para o fluxo de código. Defina `idToken` como `true` para o fluxo do token de ID.
OIDCAuthProviderConfig	A interface de configuração do provedor de autenticação [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Um provedor OIDC pode ser criado via BaseAuth.createProviderConfig() .
OIDCUpdateAuthProviderRequest	A interface de solicitação para atualizar um provedor de autenticação OIDC. Isso é usado ao atualizar a configuração de um provedor OIDC via BaseAuth.updateProviderConfig() .
PasswordPolicyConfig	Uma configuração de política de senha para um projeto ou locatário
Identificador de telefone	Usado para procurar uma conta por número de telefone. Consulte BaseAuth.getUsers() .
Identificador de Provedor	Usado para procurar uma conta por provedor federado. Consulte BaseAuth.getUsers() .
RecaptchaConfig	A interface de solicitação para atualizar uma configuração do reCAPTCHA. Ao ativar a integração reCAPTCHA Enterprise, você concorda com os Termos de serviço do reCAPTCHA Enterprise .
RecaptchaKey	A configuração da chave reCAPTCHA.
RecaptchaManagedRule	A configuração de uma regra de ação reCAPTCHA.
SAMLAuthProviderConfig	A interface de configuração do provedor de autenticação [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). Um provedor SAML pode ser criado via BaseAuth.createProviderConfig() .
SAMLUpdateAuthProviderRequest	A interface de solicitação para atualizar um provedor de autenticação SAML. Isso é usado ao atualizar a configuração de um provedor SAML via BaseAuth.updateProviderConfig() .
SessãoCookieOptions	Interface que representa as opções de cookie de sessão necessárias para o método BaseAuth.createSessionCookie() .
TotpMultiFactorProviderConfig	Interface que representa definições de configuração para autenticação de segundo fator TOTP.
UidIdentificador	Usado para procurar uma conta por uid. Consulte BaseAuth.getUsers() .
UpdatePhoneMultiFactorInfoRequest	Interface que representa um segundo fator registrado pelo usuário específico do telefone para um `UpdateRequest` .
UpdateProjectConfigRequest	Interface que representa as propriedades a serem atualizadas na configuração do projeto fornecida.
Solicitação de atualização	Interface que representa as propriedades a serem atualizadas no usuário fornecido.
AtualizarTenantRequest	Interface que representa as propriedades a serem atualizadas no locatário fornecido.
Opções de importação de usuário	Interface que representa as opções de importação do usuário necessárias para o método BaseAuth.importUsers() . Isso é usado para fornecer informações do algoritmo de hash de senha.
Registro de importação de usuário	Interface que representa um usuário a ser importado para o Firebase Auth por meio do método BaseAuth.importUsers() .
UserImportResult	Interface que representa a resposta do método BaseAuth.importUsers() para importação em lote de usuários para o Firebase Auth.
UserMetadataRequest	Metadados do usuário a serem incluídos ao importar um usuário.
Provedor de usuário	Representa um provedor de identidade de usuário que pode ser associado a um usuário do Firebase.
UserProviderRequest	Dados do provedor de usuário a serem incluídos ao importar um usuário.

Aliases de tipo

Digite Alias	Descrição
AuthFactorType	Identifica um segundo tipo de fator.
AuthProviderConfig	O tipo de configuração do provedor de autenticação. BaseAuth.createProviderConfig() .
CriarMultiFactorInfoRequest	Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um `CreateRequest` .
CriarTenantRequest	Interface que representa as propriedades a serem definidas em um novo locatário.
HashAlgorithmType
MultiFactorConfigState	Identifica um estado de configuração multifator.
PasswordPolicyEnforcementState	O estado de aplicação de uma política de senha.
RecaptchaAção	As ações a serem tomadas para solicitações protegidas por reCAPTCHA. - 'BLOCK': A solicitação protegida por reCAPTCHA será bloqueada.
RecaptchaKeyClientType	O tipo de plataforma da chave.
RecaptchaProviderEnforcementState	Estado de aplicação da proteção reCAPTCHA. - 'OFF': Não aplicado. - 'AUDITORIA': Crie avaliação, mas não imponha o resultado. - 'ENFORCE': Crie avaliação e imponha o resultado.
SmsRegionConfig	A interface de solicitação para atualizar uma configuração de região SMS. Configura as regiões onde os usuários têm permissão para enviar SMS de verificação. Isto se baseia no código de chamada do número de telefone de destino.
AtualizaçãoAuthProviderRequest
AtualizarMultiFactorInfoRequest	Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um `UpdateRequest` .
Identificador de usuário	Identifica um usuário a ser consultado.

getAuth()

Obtém o serviço Auth para o aplicativo padrão ou um determinado aplicativo.

getAuth() pode ser chamado sem argumentos para acessar o serviço Auth do aplicativo padrão ou como getAuth(app) para acessar o serviço Auth associado a um aplicativo específico.

Assinatura:

export declare function getAuth(app?: App): Auth;

Parâmetros

Parâmetro	Tipo	Descrição
aplicativo	Aplicativo

Retorna:

Autenticação

Exemplo 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

Exemplo 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

AuthFactorType

Identifica um segundo tipo de fator.

Assinatura:

export type AuthFactorType = 'phone';

AuthProviderConfig

O tipo de configuração do provedor de autenticação. BaseAuth.createProviderConfig() .

Assinatura:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CriarMultiFactorInfoRequest

Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um CreateRequest .

Assinatura:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CriarTenantRequest

Interface que representa as propriedades a serem definidas em um novo locatário.

Assinatura:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

Assinatura:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

MultiFactorConfigState

Identifica um estado de configuração multifator.

Assinatura:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

PasswordPolicyEnforcementState

O estado de aplicação de uma política de senha.

Assinatura:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RecaptchaAção

As ações a serem tomadas para solicitações protegidas por reCAPTCHA. - 'BLOCK': A solicitação protegida por reCAPTCHA será bloqueada.

Assinatura:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

O tipo de plataforma da chave.

Assinatura:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState

Estado de aplicação da proteção reCAPTCHA. - 'OFF': Não aplicado. - 'AUDITORIA': Crie avaliação, mas não imponha o resultado. - 'ENFORCE': Crie avaliação e imponha o resultado.

Assinatura:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig

A interface de solicitação para atualizar uma configuração de região SMS. Configura as regiões onde os usuários têm permissão para enviar SMS de verificação. Isto se baseia no código de chamada do número de telefone de destino.

Assinatura:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

AtualizaçãoAuthProviderRequest

Assinatura:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

AtualizarMultiFactorInfoRequest

Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um UpdateRequest .

Assinatura:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identificador de usuário

Identifica um usuário a ser consultado.

Assinatura:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;