Firebase is back at Google I/O on May 14! Register 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 do app padrão ou de 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.

Aulas

Turma	Descrição
Autenticação	Serviço de autenticação vinculado ao app fornecido. Uma instância de Auth pode ter vários locatários.
BaseAuth (link em inglês)	Interface mãe comum para as APIs `Auth` e `TenantAwareAuth`.
MultiFactorInfo (link em inglês)	Interface que representa as propriedades comuns de um segundo fator registrado pelo usuário.
MultiFactorSettings (link em inglês)	As configurações do usuário relacionadas a vários fatores.
PhoneMultiFactorInfo (link 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 atual do projeto.
Locatário	Representa uma configuração de locatário.O suporte a multilocação requer 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 na interface do console do Cloud.Uma configuração de locatário fornece informações como o nome de exibição, o identificador de locatário e a configuração de autenticação de e-mail. Para o gerenciamento de configurações do provedor OIDC/SAML, use instâncias `TenantAwareAuth` em vez de `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 permitidos 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 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 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.Cada locatário contém os próprios provedores de identidade, configurações e conjuntos de usuários. Com o `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 dos 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.As instâncias de `TenantAwareAuth` para um `tenantId` específico podem ser instanciadas chamando TenantManager.authForTenant().
TenantManager (em inglês)	Define o gerenciador de locatário usado para ajudar a gerenciar operações relacionadas ao locatário. Isso inclui: Capacidade de criar, atualizar, listar, receber e excluir locatários para o 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.
Informações do usuário	Representa as informações de um usuário a partir de um provedor de identidade de terceiros, como Google ou Facebook.
UserMetadata (link em inglês)	Representa os metadados de um usuário.
UserRecord (link em inglês)	Representa um usuário.

Interfaces

Interface	Descrição
ActionCodeSettings.	Essa é a interface que define o URL obrigatório de estado/continue com os identificadores opcionais do pacote Android e iOS.
AllowByDefault (link em inglês)	Define uma política que permite todas as regiões por padrão e adiciona 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
Somente lista de permissões	Define uma política para permitir somente regiões, adicionando-as explicitamente a uma lista de permissões.
AllowlistOnlyWrap (link em inglês)	Configuração de região de SMS mutuamente exclusiva da interface AllowlistOnly
AuthProviderConfigFilter (link 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 base.
BaseCreateMultiFactorInfoRequest (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 um `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest (link em inglês)	Interface que representa um segundo fator registrado pelo usuário específico do smartphone para um `CreateRequest`.
CreateRequest (link em inglês)	Interface que representa as propriedades a serem definidas em um novo registro do 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 do token de ID das especificações do OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) para obter mais informações sobre as propriedades específicas abaixo.
DeleteUsersResult	Representa o resultado da API BaseAuth.deleteUsers().
EmailIdentifier (link em inglês)	Usado para procurar uma conta por e-mail.Consulte BaseAuth.getUsers().
EmailPrivacyConfig (link 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	Representa o resultado da API BaseAuth.getUsers().
ListProviderConfigResults (em inglês)	A interface de resposta para listar as configurações do provedor. Disponível apenas ao listar as configurações de todos os provedores de identidade via 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 para o lote atual e o próximo token de 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 com suporte.
MultiFactorCreateSettings (link em inglês)	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 segundo fator diferentes de SMS. Atualmente, apenas o TOTP é aceito.
MultiFactorUpdateSettings (em inglês)	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 do OIDC para o fluxo de autorização OAuth. Uma das configurações a seguir é necessá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 de autenticação [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Um provedor OIDC pode ser criado usando BaseAuth.createProviderConfig().
OIDCUpdateAuthProviderRequest (em inglês)	A interface de solicitação para atualizar um provedor de autenticação OIDC. Usado ao atualizar a configuração de um provedor OIDC via BaseAuth.updateProviderConfig().
PasswordPolicyConfig	Configuração de política de senha para um projeto ou locatário
PhoneIdentifier (link em inglês)	Usado para procurar uma conta pelo número de telefone.Consulte BaseAuth.getUsers().
ProviderIdentifier (link em inglês)	Usado para procurar uma conta pelo 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 com o 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	A configuração de uma regra de ação do 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). Um provedor SAML pode ser criado via BaseAuth.createProviderConfig().
SAMLUpdateAuthProviderRequest (em inglês)	A interface de solicitação para atualizar um provedor de autenticação SAML. É usado na atualização da 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 (link em inglês)	Interface que representa as definições de configuração da autenticação de segundo fator do TOTP.
UidIdentifier (link em inglês)	Usado para pesquisar uma conta pelo uid.Consulte BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest (link em inglês)	Interface que representa um segundo fator registrado pelo usuário específico do smartphone para uma `UpdateRequest`.
UpdateProjectConfigRequest (em inglês)	Interface que representa as propriedades a serem atualizadas na configuração do projeto fornecida.
UpdateRequest (link em inglês)	Interface que representa as propriedades a serem atualizadas no usuário fornecido.
UpdateTenantRequest (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 do usuário necessárias para o método BaseAuth.importUsers(). Isso é usado para fornecer as informações do algoritmo de hash de senha.
UserImportRecord (link em inglês)	Interface que representa um usuário a ser importado para o Firebase Auth pelo método BaseAuth.importUsers().
UserImportResult (link em inglês)	Interface que representa a resposta do método BaseAuth.importUsers() para importar usuários em lote para o Firebase Auth.
UserMetadataRequest (link em inglês)	Metadados do usuário a serem incluídos na importação.
UserProvider (link em inglês)	Representa um provedor de identidade do usuário que pode ser associado a um usuário do Firebase.
UserProviderRequest (link em inglês)	Dados do provedor do usuário a serem incluídos na importação de um usuário.

Aliases de tipos

Tipo de alias	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 (link em inglês)	Tipo que representa as propriedades de um segundo fator registrado pelo usuário para uma `CreateRequest`.
CreateTenantRequest (em inglês)	Interface que representa as propriedades a serem definidas em um novo locatário.
HashalgorithmType (em inglês)
MultiFactorConfigState (em inglês)	Identifica um estado de configuração de vários fatores.
PasswordPolicyEnforcementState (em inglês)	Estado de aplicação de uma política de senha.
RecaptchaAction (link em inglês)	As ações a serem tomadas para solicitações protegidas pelo reCAPTCHA. - 'BLOCK': a solicitação protegida pelo reCAPTCHA será bloqueada.
RecaptchaKeyClientType (link em inglês)	O tipo de plataforma da chave.
RecaptchaProviderEnforcementState (em inglês)	Estado de aplicação da proteção reCAPTCHA. - 'OFF': não aplicado. - "AUDIT": cria a avaliação, mas não aplica o resultado. - "ENFORCE": criar uma avaliação e aplicar o resultado.
SmsRegionConfig (em inglês)	A interface de solicitação para atualizar uma configuração de região de SMS. Configura as regiões em que os usuários têm permissão para enviar um SMS de verificação. Isso se baseia no código de chamada do número de telefone de destino.
UpdateAuthProviderRequest (em inglês)
UpdateMultiFactorInfoRequest (link em inglês)	Tipo que representa as propriedades de um segundo fator registrado pelo usuário para uma `UpdateRequest`.
UserIdentifier (link 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.

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

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;

CreateMultiFactorInfoRequest

Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um 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;

HashAlgoritmo

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

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

Tipo de Cliente de Chave RecaptchaKeyClient

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. - "AUDIT": cria a avaliação, mas não aplica o resultado. - "ENFORCE": criar uma 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 em que os usuários têm permissão para enviar um SMS de verificação. Isso se baseia 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 um 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;