Watch demos on how to build & run AI-powered apps with Firebase at Demo Day '24. Watch now.

Esta página foi traduzida pela API Cloud Translation.

firebase-admin.auth package

Firebase Authentication.

Funções

Função	Descrição
getAuth(app) (em inglês)	Recebe o serviço Auth para o app padrão ou para um determinado app.`getAuth()` pode ser chamado sem argumentos para acessar o serviço Auth do app padrão ou como `getAuth(app)` para acessar o serviço Auth associado a um app específico.

Classes

Turma	Descrição
Autenticação	Serviço de autenticação vinculado ao app fornecido. Uma instância do Auth pode ter vários locatários.
AuthClientErrorCode (em inglês)	Códigos de erro do cliente Auth e as mensagens padrão deles.
BaseAuth (em inglês)	Interface pai comum para as APIs `Auth` e `TenantAwareAuth`.
FirebaseAuthError (em inglês)	Estrutura do código de erro do Firebase Auth. Isso estende PrefixedFirebaseError.
MultiFactorInfo (em inglês)	Interface que representa as propriedades comuns de um segundo fator registrado pelo usuário.
MultiFactorSettings (em inglês)	As configurações do usuário relacionadas aos vários fatores.
PhoneMultiFactorInfo (em inglês)	Interface que representa um segundo fator registrado pelo usuário específico do smartphone.
ProjectConfig (em inglês)	Representa uma configuração de projeto.
ProjectConfigManager (em inglês)	Gerencia (recebe e atualiza) a configuração do projeto atual.
Locatário	Representa uma configuração de locatário.O suporte a multilocação exige o Identity Platform (GCIP) do Google Cloud. 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 ser permitidos nesse projeto pela interface do console do Cloud.Uma configuração do locatário fornece informações como nome de exibição, identificador do locatário e configuração da autenticação de e-mail. Para o gerenciamento de configuração do provedor OIDC/SAML, em vez de um `Tenant`, é preciso usar instâncias `TenantAwareAuth` para recuperar a lista de IdPs configurados em um locatário. Ao configurar esses provedores, observe que os locatários vão herdar os domínios na lista de permissões e os 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 interface do console do Cloud.
TenantAwareAuth (link em inglês)	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 multilocação exige o Identity Platform (GCIP) do Google Cloud. Para saber mais sobre o GCIP, incluindo preços e recursos, consulte a documentação do GCIP.Cada locatário contém os próprios provedores de identidade, configurações e conjuntos de usuários. Com o `TenantAwareAuth`, usuários de um locatário específico e as configurações OIDC/SAML correspondentes também podem ser gerenciadas, os tokens de ID para usuários que fizeram login em um locatário específico podem ser verificados e links de ação de e-mail também podem ser gerados para usuários que pertencem ao locatário.Instâncias de `TenantAwareAuth` para um `tenantId` específico podem ser instanciadas chamando TenantManager.authForTenant().
TenantManager (link em inglês)	Define o gerenciador de locatários usado para ajudar a gerenciar operações relacionadas ao locatário. Isso inclui: A capacidade de criar, atualizar, listar, receber e excluir locatários do projeto subjacente. Receber 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 links de e-mail etc.) no contexto de um locatário especificado.
UserInfo (em inglês)	Representa as informações de um usuário de um provedor de identidade de terceiros, como o Google ou o Facebook.
UserMetadata (em inglês)	Representa os metadados de um usuário.
UserRecord (em inglês)	Representa um usuário.

Interfaces

Interface	Descrição
ActionCodeSettings (em inglês).	Essa é a interface que define o URL de estado/contínuo necessário com identificadores opcionais dos pacotes Android e iOS.
AllowByDefault (link em inglês)	Define uma política para permitir todas as regiões por padrão e adicionar regiões não permitidas a uma lista de proibições.
AllowByDefaultWrap (link em inglês)	Configuração de região de SMS exclusiva mútua da interface AllowByDefault
AllowlistOnly (em inglês)	Define uma política de permitir apenas regiões, adicionando-as explicitamente a uma lista de permissões.
AllowlistOnlyWrap (em inglês)	Configuração de região de SMS mutuamente exclusiva da interface "AllowlistOnly"
AuthProviderConfigFilter (em inglês)	A interface de filtro usada para listar as configurações do provedor. Usado ao especificar como listar os provedores de identidade configurados via BaseAuth.listProviderConfigs().
BaseAuthProviderConfig (em inglês)	A interface de configuração do provedor de autenticação básico.
BaseCreateMultiFactorInfoRequest (link em inglês)	Interface que representa as propriedades base de um segundo fator registrado pelo usuário para um `CreateRequest`.
BaseUpdateMultiFactorInfoRequest (em inglês)	Interface que representa propriedades comuns de um segundo fator registrado pelo usuário para uma `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest (em inglês)	Interface que representa um segundo fator específico do smartphone registrado pelo usuário para um `CreateRequest`.
CreateRequest (em inglês)	Interface que representa as propriedades a serem definidas em um novo registro de usuário a ser criado.
CustomStrengthOptionsConfig (em inglês)	Restrições a serem aplicadas na política de senha
DeencodedAuthBlockingToken (em inglês)
DeencodedIdToken (em inglês)	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 "Token de ID" da especificação do OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) para saber mais sobre as propriedades específicas abaixo.
DeleteUsersResult (link em inglês)	Representa o resultado da BaseAuth.deleteUsers(). API.
EmailIdentifier (em inglês)	Usado para procurar uma conta por e-mail.Consulte BaseAuth.getUsers().
EmailPrivacyConfig (em inglês)	A configuração de privacidade de e-mail de um projeto ou locatário.
EmailSignInProviderConfig (em inglês)	Configuração do provedor de login de e-mail.
GetUsersResult (em inglês)	Representa o resultado da API BaseAuth.getUsers().
ListProviderConfigResults (link em inglês)	A interface de resposta para listar as configurações do provedor. Disponível apenas ao listar os provedores de identidade por BaseAuth.listProviderConfigs().
ListTenantsResult (link em inglês)	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 (link em inglês)	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 (em inglês)	Interface que representa uma configuração de vários fatores. Isso pode ser usado para definir se a autenticação multifator está ativada ou desativada e a lista de desafios de dois fatores compatíveis.
MultiFactorCreateSettings	As configurações de usuário relacionadas a vários fatores para operações de criação.
MultiFactorProviderConfig (em inglês)	Interface que representa a configuração de um provedor de autenticação multifator. Essa interface é usada para provedores de autenticação de dois fatores diferentes de SMS. Atualmente, apenas o TOTP é compatível.
MultiFactorUpdateSettings	As configurações do usuário relacionadas a vários fatores para operações de atualização.
OAuthResponseType (em inglês).	A interface que representa o objeto de resposta do provedor OIDC para o fluxo de autorização do OAuth. Uma das seguintes configurações é obrigatória: Defina `code` como `true` para o fluxo de código. Defina `idToken` como `true` para o fluxo do token de ID.
OIDCAuthProviderConfig (em inglês)	A interface de configuração do provedor do Auth [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). É possível criar um provedor OIDC por meio de BaseAuth.createProviderConfig().
OIDCUpdateAuthProviderRequest (em inglês)	A interface de solicitação para atualizar um provedor do OIDC Auth. Usado ao atualizar a configuração de um provedor OIDC por meio de BaseAuth.updateProviderConfig().
PasswordPolicyConfig (link em inglês)	Uma configuração de política de senha para um projeto ou locatário
PhoneIdentifier (em inglês)	Usado para procurar uma conta pelo número de telefone.Consulte BaseAuth.getUsers().
ProviderIdentifier (em inglês)	Usado para procurar uma conta por provedor federado.Consulte BaseAuth.getUsers().
RecaptchaConfig (em inglês)	A interface de solicitação para atualizar uma configuração do reCAPTCHA. Ao ativar a integração do reCAPTCHA Enterprise, você concorda com os Termos de Serviço do reCAPTCHA Enterprise.
RecaptchaKey (link em inglês)	A configuração da chave reCAPTCHA.
RecaptchaManagedRule (em inglês)	A configuração de uma regra de ação reCAPTCHA.
SAMLAuthProviderConfig (em inglês)	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). É possível criar um provedor SAML via BaseAuth.createProviderConfig().
SAMLUpdateAuthProviderRequest (em inglês)	A interface de solicitação para atualizar um provedor de autenticação SAML. Usado ao atualizar a configuração de um provedor SAML via BaseAuth.updateProviderConfig().
SessionCookieOptions (em inglês)	Interface que representa as opções de cookie de sessão necessárias para o método BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig (em inglês)	Interface que representa as definições de configuração para a autenticação de dois fatores do TOTP.
UidIdentifier (link em inglês)	Usado para procurar uma conta pelo uid.Consulte BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest (em inglês)	Interface que representa um segundo fator específico do smartphone registrado pelo usuário para uma `UpdateRequest`.
AtualizarProjectConfigRequest (em inglês)	Interface que representa as propriedades a serem atualizadas na configuração do projeto fornecida.
UpdateRequest (em inglês)	Interface que representa as propriedades a serem atualizadas no usuário fornecido.
UpdateTenantRequest (link em inglês)	Interface que representa as propriedades a serem atualizadas no locatário fornecido.
UserImportOptions (em inglês)	Interface que representa as opções de importação de usuário necessárias para o método BaseAuth.importUsers(). Ele é usado para fornecer as informações do algoritmo de hash de senha.
UserImportRecord (em inglês)	Interface que representa um usuário para importar para o Firebase Auth pelo método BaseAuth.importUsers().
UserImportResult (em inglês)	Interface que representa a resposta do método BaseAuth.importUsers() para importar usuários em lote para o Firebase Auth.
UserMetadataRequest (em inglês)	Metadados do usuário a serem incluídos ao importar um usuário.
UserProvider (em inglês)	Representa um provedor de identidade do usuário que pode ser associado a um usuário do Firebase.
UserProviderRequest (em inglês)	Dados do provedor do usuário a serem incluídos ao importar um usuário.

Aliases de tipos

Alias de tipo	Descrição
AuthFactorType (em inglês)	Identifica um segundo tipo de fator.
AuthProviderConfig (em inglês)	O tipo de configuração do provedor de autenticação. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest (em inglês)	Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um `CreateRequest`.
CreateTenantRequest (link em inglês)	Interface que representa as propriedades a serem definidas em um novo locatário.
HashAlgorithmType (em inglês)
MultiFactorConfigState	Identifica um estado de configuração de vários fatores.
PasswordPolicyEnforcementState (em inglês)	O estado de aplicação de uma política de senha.
RecaptchaAction	As ações a serem tomadas para solicitações protegidas pelo reCAPTCHA. - 'BLOCK': a solicitação protegida pelo reCAPTCHA será bloqueada.
RecaptchaKeyClientType (em inglês)	O tipo de plataforma da chave.
RecaptchaProviderEnforcementState (em inglês)	Estado de aplicação da proteção reCAPTCHA. - 'DESATIVADO': não aplicado. – "AUDITORIA": crie a avaliação, mas não aplique o resultado. - "ENFORCE": criar avaliação e aplicar o resultado.
SmsRegionConfig (link em inglês)	A interface de solicitação para atualizar uma configuração de região de SMS. Configura as regiões para onde os usuários têm permissão para enviar SMS de verificação. Isso é baseado no código de chamada do número de telefone de destino.
UpdateAuthProviderRequest (em inglês)
UpdateMultiFactorInfoRequest (em inglês)	Tipo que representa as propriedades de um segundo fator registrado pelo usuário para uma `UpdateRequest`.
UserIdentifier (em inglês)	Identifica um usuário a ser pesquisado.

getAuth(app)

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

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

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
app	App

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);

Tipo de autenticação

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;

CreateMultiFactorInfoRequest

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

Assinatura:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

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

Assinatura:

export type CreateTenantRequest = UpdateTenantRequest;

Tipo de algoritmo

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 de vários fatores.

Assinatura:

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

PasswordPolicyEnforcementState

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

Assinatura:

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

RecaptchaAction

As ações a serem tomadas para solicitações protegidas pelo reCAPTCHA. - 'BLOCK': a solicitação protegida pelo 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. - 'DESATIVADO': não aplicado. – "AUDITORIA": crie a avaliação, mas não aplique o resultado. - "ENFORCE": criar avaliação e aplicar o resultado.

Assinatura:

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

SmsRegionConfig

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

Assinatura:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Assinatura:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

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

Assinatura:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identificador do usuário

Identifica um usuário a ser pesquisado.

Assinatura:

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