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.

BaseAuth class

Interface pai comum para APIs Auth e TenantAwareAuth .

Assinatura:

export declare abstract class BaseAuth

Métodos

Método	Modificadores	Descrição
createCustomToken(uid, desenvolvedorClaims)		Cria um novo token personalizado do Firebase (JWT) que pode ser enviado de volta a um dispositivo cliente para ser usado para fazer login com os métodos `signInWithCustomToken()` dos SDKs do cliente. (As instâncias com reconhecimento de locatário também incorporarão o ID do locatário no token.) Consulte Criar tokens personalizados para obter exemplos de código e documentação detalhada.
createProviderConfig(config)		Retorna uma promessa que é resolvida com o `AuthProviderConfig` recém-criado quando a nova configuração do provedor é criada. O suporte do provedor SAML e OIDC 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 .
createSessionCookie(idToken, sessionCookieOptions)		Cria um novo cookie de sessão do Firebase com as opções especificadas. A string JWT criada pode ser definida como um cookie de sessão do lado do servidor com uma política de cookies personalizada e usada para gerenciamento de sessão. O JWT do cookie de sessão terá as mesmas declarações de carga que o token de ID fornecido. Consulte Gerenciar cookies de sessão para obter exemplos de código e documentação detalhada.
createUser(propriedades)		Cria um novo usuário. Consulte Criar um usuário para obter exemplos de código e documentação detalhada.
deleteProviderConfig(providerId)		Exclui a configuração do provedor correspondente ao ID do provedor passado. Se o ID especificado não existir, um erro `auth/configuration-not-found` será gerado. O suporte do provedor SAML e OIDC 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 .
deletarUsuário(uid)		Exclui um usuário existente. Consulte Excluir um usuário para obter exemplos de código e documentação detalhada.
deleteUsers(uids)		Exclui os usuários especificados pelos uids fornecidos. Excluir um usuário inexistente não gerará um erro (ou seja, este método é idempotente). Usuários inexistentes são considerados excluídos com êxito e, portanto, são contados no valor `DeleteUsersResult.successCount` . Apenas um máximo de 1000 identificadores podem ser fornecidos. Se mais de 1.000 identificadores forem fornecidos, esse método gerará um FirebaseAuthError. Esta API está atualmente com taxa limitada no servidor a 1 QPS. Se você exceder esse valor, poderá receber um erro de cota excedida. Portanto, se você quiser excluir mais de 1.000 usuários, pode ser necessário adicionar um atraso para garantir que esse limite não seja ultrapassado.
generateEmailVerificationLink(email, actionCodeSettings)		Gera o link de ação de e-mail fora de banda para verificar a propriedade do usuário sobre o e-mail especificado. O objeto ActionCodeSettings fornecido como argumento para este método define se o link deve ser manipulado por um aplicativo móvel ou navegador junto com informações de estado adicionais a serem passadas no link direto, etc.
generatePasswordResetLink(e-mail, actionCodeSettings)		Gera o link de ação de e-mail fora de banda para redefinir a senha de um usuário. O link é gerado para o usuário com o endereço de e-mail especificado. O objeto opcional ActionCodeSettings define se o link deve ser tratado por um aplicativo móvel ou navegador e as informações adicionais de estado a serem passadas no link direto, etc.
generateSignInWithEmailLink(email, actionCodeSettings)		Gera o link de ação de e-mail fora de banda para verificar a propriedade do usuário sobre o e-mail especificado. O objeto ActionCodeSettings fornecido como argumento para este método define se o link deve ser manipulado por um aplicativo móvel ou navegador junto com informações de estado adicionais a serem passadas no link direto, etc.
generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings)		Gera um link de ação de e-mail fora de banda para verificar a propriedade do usuário sobre o e-mail especificado. O objeto ActionCodeSettings fornecido como argumento para este método define se o link deve ser manipulado por um aplicativo móvel ou navegador junto com informações de estado adicionais a serem passadas no link direto, etc.
getProviderConfig(providerId)		Procura uma configuração de provedor de autenticação pelo ID fornecido. Retorna uma promessa que é resolvida com a configuração do provedor correspondente ao ID do provedor especificado. Se o ID especificado não existir, um erro `auth/configuration-not-found` será gerado. O suporte do provedor SAML e OIDC 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 .
getUsuário(uid)		Obtém os dados do usuário correspondentes a um determinado `uid` . Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.
getUserByEmail(e-mail)		Obtém os dados do usuário correspondente a um determinado email. Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.
getUserByPhoneNumber(número de telefone)		Obtém os dados do usuário correspondente a um determinado número de telefone. O número de telefone deve estar em conformidade com a especificação E.164. Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.
getUserByProviderUid(providerId,uid)		Obtém os dados do usuário correspondente a um determinado ID de provedor. Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.
getUsers(identificadores)		Obtém os dados do usuário correspondentes aos identificadores especificados. Não há garantias de pedido; em particular, não é garantido que a enésima entrada na lista de resultados corresponda à enésima entrada na lista de parâmetros de entrada. Apenas um máximo de 100 identificadores podem ser fornecidos. Se mais de 100 identificadores forem fornecidos, esse método gerará um FirebaseAuthError.
importUsers(usuários, opções)		Importa a lista de usuários fornecida para o Firebase Auth. É permitido importar no máximo 1.000 usuários, um de cada vez. Ao importar usuários com senhas, é necessário especificar UserImportOptions . Esta operação é otimizada para importações em massa e ignorará verificações de `uid` , `email` e outras exclusividades de identificadores que podem resultar em duplicações.
listProviderConfigs(opções)		Retorna a lista de configurações de provedores existentes que correspondem ao filtro fornecido. No máximo, 100 configurações de provedor podem ser listadas por vez. O suporte do provedor SAML e OIDC 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 .
listUsers(maxResults, pageToken)		Recupera uma lista de usuários (somente lote único) com um tamanho `maxResults` começando no deslocamento especificado por `pageToken` . Isso é usado para recuperar todos os usuários de um projeto especificado em lotes. Consulte Listar todos os usuários para obter exemplos de código e documentação detalhada.
revogarRefreshTokens(uid)		Revoga todos os tokens de atualização de um usuário existente. Esta API atualizará UserRecord.tokensValidAfterTime do usuário para o UTC atual. É importante que o servidor no qual isso é chamado tenha seu relógio acertado e sincronizado. Embora isso revogue todas as sessões de um usuário especificado e desabilite a criação de novos tokens de ID para sessões existentes, os tokens de ID existentes podem permanecer ativos até sua expiração natural (uma hora). Para verificar se os tokens de ID foram revogados, use BaseAuth.verifyIdToken() onde `checkRevoked` está definido como verdadeiro.
setCustomUserClaims(uid, customUserClaims)		Define declarações adicionais do desenvolvedor sobre um usuário existente identificado pelo `uid` fornecido, normalmente usado para definir funções de usuário e níveis de acesso. Essas declarações devem ser propagadas para todos os dispositivos onde o usuário já estiver conectado (após a expiração do token ou quando a atualização do token for forçada) e na próxima vez que o usuário entrar. Se um nome de declaração OIDC reservado for usado (sub, iat, iss, etc. ), um erro é gerado. Eles são definidos no JWT do token de ID do usuário autenticado. Consulte Definindo funções de usuário e níveis de acesso para exemplos de código e documentação detalhada.
updateProviderConfig(providerId, atualizadoConfig)		Retorna uma promessa que é resolvida com o `AuthProviderConfig` atualizado correspondente ao ID do provedor especificado. Se o ID especificado não existir, um erro `auth/configuration-not-found` será gerado. O suporte do provedor SAML e OIDC 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 .
updateUser(uid, propriedades)		Atualiza um usuário existente. Consulte Atualizar um usuário para obter exemplos de código e documentação detalhada.
verifyIdToken(idToken, checkRevoked)		Verifica um token de ID do Firebase (JWT). Se o token for válido, a promessa será cumprida com as declarações decodificadas do token; caso contrário, a promessa será rejeitada. Se `checkRevoked` estiver definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado. Se sim, um erro `auth/user-disabled` será gerado. Se não, verifica se a sessão correspondente ao ID token foi revogada. Se a sessão do usuário correspondente for invalidada, um erro `auth/id-token-revoked` será gerado. Se não for especificado, a verificação não será aplicada. Consulte Verificar tokens de ID para obter exemplos de código e documentação detalhada.
verifySessionCookie(sessionCookie, checkRevoked)		Verifica um cookie de sessão do Firebase. Retorna uma promessa com as reivindicações do cookie. Rejeita a promessa se o cookie não puder ser verificado. Se `checkRevoked` for definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado: se sim, um erro `auth/user-disabled` é lançado. Se não, verifica se a sessão correspondente ao cookie de sessão foi revogada. Se a sessão do usuário correspondente for invalidada, um erro `auth/session-cookie-revoked` será gerado. Se não for especificado, a verificação não será executada. Consulte Verificar cookies de sessão para exemplos de código e documentação detalhada

BaseAuth.createCustomToken()

Cria um novo token personalizado do Firebase (JWT) que pode ser enviado de volta a um dispositivo cliente para ser usado para fazer login com os métodos signInWithCustomToken() dos SDKs do cliente. (As instâncias com reconhecimento de locatário também incorporarão o ID do locatário no token.)

Consulte Criar tokens personalizados para obter exemplos de código e documentação detalhada.

Assinatura:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
UID	corda	O `uid` a ser usado como assunto do token personalizado.
desenvolvedorClaims	objeto	Declarações adicionais opcionais a serem incluídas na carga útil do token personalizado.

Retorna:

Promessa<string>

Uma promessa cumprida com um token personalizado para o uid e a carga útil fornecidos.

BaseAuth.createProviderConfig()

Retorna uma promessa que é resolvida com o AuthProviderConfig recém-criado quando a nova configuração do provedor é criada.

O suporte do provedor SAML e OIDC 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 .

Assinatura:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

Parâmetros

Parâmetro	Tipo	Descrição
configuração	AuthProviderConfig	A configuração do provedor a ser criada.

Retorna:

Promessa< AuthProviderConfig >

Uma promessa que é resolvida com a configuração do provedor criada.

BaseAuth.createSessionCookie()

Cria um novo cookie de sessão do Firebase com as opções especificadas. A string JWT criada pode ser definida como um cookie de sessão do lado do servidor com uma política de cookies personalizada e usada para gerenciamento de sessão. O JWT do cookie de sessão terá as mesmas declarações de carga que o token de ID fornecido.

Consulte Gerenciar cookies de sessão para obter exemplos de código e documentação detalhada.

Assinatura:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
idToken	corda	O token de ID do Firebase a ser trocado por um cookie de sessão.
sessãoCookieOptions	SessãoCookieOptions	As opções de cookies de sessão que incluem duração de sessão personalizada.

Retorna:

Promessa<string>

Uma promessa que é resolvida com sucesso com o cookie de sessão criado.

BaseAuth.createUser()

Cria um novo usuário.

Consulte Criar um usuário para obter exemplos de código e documentação detalhada.

Assinatura:

createUser(properties: CreateRequest): Promise<UserRecord>;

Parâmetros

Parâmetro	Tipo	Descrição
propriedades	Criar solicitação	As propriedades a serem definidas no novo registro de usuário a ser criado.

Retorna:

Promessa< UserRecord >

Uma promessa cumprida com os dados do usuário correspondentes ao usuário recém-criado.

BaseAuth.deleteProviderConfig()

Exclui a configuração do provedor correspondente ao ID do provedor passado. Se o ID especificado não existir, um erro auth/configuration-not-found será gerado.

O suporte do provedor SAML e OIDC 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 .

Assinatura:

deleteProviderConfig(providerId: string): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
ID do provedor	corda	O ID do provedor correspondente à configuração do provedor a ser excluída.

Retorna:

Promessa<void>

Uma promessa que se resolve na conclusão.

BaseAuth.deleteUser()

Exclui um usuário existente.

Consulte Excluir um usuário para obter exemplos de código e documentação detalhada.

Assinatura:

deleteUser(uid: string): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
UID	corda	O `uid` correspondente ao usuário a ser excluído.

Retorna:

Promessa<void>

Uma promessa vazia cumprida quando o usuário é excluído.

BaseAuth.deleteUsers()

Exclui os usuários especificados pelos uids fornecidos.

Excluir um usuário inexistente não gerará um erro (ou seja, este método é idempotente). Usuários inexistentes são considerados excluídos com êxito e, portanto, são contados no valor DeleteUsersResult.successCount .

Apenas um máximo de 1000 identificadores podem ser fornecidos. Se mais de 1.000 identificadores forem fornecidos, esse método gerará um FirebaseAuthError.

Esta API está atualmente com taxa limitada no servidor a 1 QPS. Se você exceder esse valor, poderá receber um erro de cota excedida. Portanto, se você quiser excluir mais de 1.000 usuários, pode ser necessário adicionar um atraso para garantir que esse limite não seja ultrapassado.

Assinatura:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

Parâmetros

Parâmetro	Tipo	Descrição
UIDs	corda[]	Os `uids` correspondentes aos usuários a serem excluídos.

Retorna:

Promessa< DeleteUsersResult >

Uma promessa que resolve o número total de exclusões bem-sucedidas/com falha, bem como a matriz de erros que corresponde às exclusões com falha.

BaseAuth.generateEmailVerificationLink()

Gera o link de ação de e-mail fora de banda para verificar a propriedade do usuário sobre o e-mail especificado. O objeto ActionCodeSettings fornecido como argumento para este método define se o link deve ser manipulado por um aplicativo móvel ou navegador junto com informações de estado adicionais a serem passadas no link direto, etc.

Assinatura:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
e-mail	corda	A conta de e-mail a ser verificada.
configurações de código de ação	Configurações de ActionCode	As configurações do código de ação. Se especificado, o URL de estado/continuação será definido como o parâmetro "continueUrl" no link de verificação de e-mail. A página inicial de verificação de e-mail padrão usará isso para exibir um link para voltar ao aplicativo, se ele estiver instalado. Se actionCodeSettings não for especificado, nenhum URL será anexado ao URL de ação. O URL de estado fornecido deve pertencer a um domínio incluído na lista de permissões do desenvolvedor no console. Caso contrário, um erro será gerado. Os redirecionamentos de aplicativos para dispositivos móveis só serão aplicáveis se o desenvolvedor configurar e aceitar os termos de serviço do Firebase Dynamic Links. O nome do pacote Android e o ID do pacote iOS serão respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Retorna:

Promessa<string>

Uma promessa que se resolve com o link gerado.

Exemplo

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generatePasswordResetLink()

Gera o link de ação de e-mail fora de banda para redefinir a senha de um usuário. O link é gerado para o usuário com o endereço de e-mail especificado. O objeto opcional ActionCodeSettings define se o link deve ser tratado por um aplicativo móvel ou navegador e as informações adicionais de estado a serem passadas no link direto, etc.

Assinatura:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
e-mail	corda	O endereço de e-mail do usuário cuja senha será redefinida.
configurações de código de ação	Configurações de ActionCode	As configurações do código de ação. Se especificado, o URL de estado/continuação será definido como o parâmetro "continueUrl" no link de redefinição de senha. A página inicial de redefinição de senha padrão usará isso para exibir um link para voltar ao aplicativo, se ele estiver instalado. Se actionCodeSettings não for especificado, nenhum URL será anexado ao URL de ação. O URL de estado fornecido deve pertencer a um domínio incluído na lista de permissões do desenvolvedor no console. Caso contrário, um erro será gerado. Os redirecionamentos de aplicativos para dispositivos móveis só serão aplicáveis se o desenvolvedor configurar e aceitar os termos de serviço do Firebase Dynamic Links. O nome do pacote Android e o ID do pacote iOS serão respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Retorna:

Promessa<string>

Uma promessa que se resolve com o link gerado.

Exemplo

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateSignInWithEmailLink()

Assinatura:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
e-mail	corda	A conta de e-mail a ser verificada.
configurações de código de ação	Configurações de ActionCode	As configurações do código de ação. Se especificado, o URL de estado/continuação será definido como o parâmetro "continueUrl" no link de verificação de e-mail. A página inicial de verificação de e-mail padrão usará isso para exibir um link para voltar ao aplicativo, se ele estiver instalado. Se actionCodeSettings não for especificado, nenhum URL será anexado ao URL de ação. O URL de estado fornecido deve pertencer a um domínio incluído na lista de permissões do desenvolvedor no console. Caso contrário, um erro será gerado. Os redirecionamentos de aplicativos para dispositivos móveis só serão aplicáveis se o desenvolvedor configurar e aceitar os termos de serviço do Firebase Dynamic Links. O nome do pacote Android e o ID do pacote iOS serão respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Retorna:

Promessa<string>

Uma promessa que se resolve com o link gerado.

Exemplo

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateVerifyAndChangeEmailLink()

Gera um link de ação de e-mail fora de banda para verificar a propriedade do usuário sobre o e-mail especificado. O objeto ActionCodeSettings fornecido como argumento para este método define se o link deve ser manipulado por um aplicativo móvel ou navegador junto com informações de estado adicionais a serem passadas no link direto, etc.

Assinatura:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
e-mail	corda	A conta de e-mail atual.
Novo Email	corda	O endereço de e-mail para o qual a conta está sendo atualizada.
configurações de código de ação	Configurações de ActionCode	As configurações do código de ação. Se especificado, o URL de estado/continuação será definido como o parâmetro "continueUrl" no link de verificação de e-mail. A página inicial de verificação de e-mail padrão usará isso para exibir um link para voltar ao aplicativo, se ele estiver instalado. Se actionCodeSettings não for especificado, nenhum URL será anexado ao URL de ação. A URL de estado fornecida deve pertencer a um domínio autorizado no console ou um erro será gerado. Os redirecionamentos de aplicativos para dispositivos móveis só serão aplicáveis se o desenvolvedor configurar e aceitar os termos de serviço do Firebase Dynamic Links. O nome do pacote Android e o ID do pacote iOS serão respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Retorna:

Promessa<string>

Uma promessa que se resolve com o link gerado.

BaseAuth.getProviderConfig()

Procura uma configuração de provedor de autenticação pelo ID fornecido. Retorna uma promessa que é resolvida com a configuração do provedor correspondente ao ID do provedor especificado. Se o ID especificado não existir, um erro auth/configuration-not-found será gerado.

O suporte do provedor SAML e OIDC 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 .

Assinatura:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

Parâmetros

Parâmetro	Tipo	Descrição
ID do provedor	corda	O ID do provedor correspondente à configuração do provedor a ser retornada.

Retorna:

Promessa< AuthProviderConfig >

Uma promessa que resolve com a configuração correspondente ao ID fornecido.

BaseAuth.getUser()

Obtém os dados do usuário correspondentes a um determinado uid .

Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.

Assinatura:

getUser(uid: string): Promise<UserRecord>;

Parâmetros

Parâmetro	Tipo	Descrição
UID	corda	O `uid` correspondente ao usuário cujos dados serão buscados.

Retorna:

Promessa< UserRecord >

Uma promessa cumprida com os dados do usuário correspondentes ao uid fornecido .

BaseAuth.getUserByEmail()

Obtém os dados do usuário correspondente a um determinado email.

Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.

Assinatura:

getUserByEmail(email: string): Promise<UserRecord>;

Parâmetros

Parâmetro	Tipo	Descrição
e-mail	corda	O e-mail correspondente ao usuário cujos dados serão buscados.

Retorna:

Promessa< UserRecord >

Uma promessa cumprida com os dados do usuário correspondentes ao email fornecido.

BaseAuth.getUserByPhoneNumber()

Obtém os dados do usuário correspondente a um determinado número de telefone. O número de telefone deve estar em conformidade com a especificação E.164.

Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.

Assinatura:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

Parâmetros

Parâmetro	Tipo	Descrição
número de telefone	corda	O número de telefone correspondente ao usuário cujos dados serão buscados.

Retorna:

Promessa< UserRecord >

Uma promessa cumprida com os dados do usuário correspondentes ao número de telefone fornecido.

BaseAuth.getUserByProviderUid()

Obtém os dados do usuário correspondente a um determinado ID de provedor.

Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada.

Assinatura:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

Parâmetros

Parâmetro	Tipo	Descrição
ID do provedor	corda	O ID do provedor, por exemplo, "google.com" do provedor Google.
UID	corda	O identificador de usuário do provedor fornecido.

Retorna:

Promessa< UserRecord >

Uma promessa cumprida com os dados do usuário correspondentes ao ID do provedor fornecido.

BaseAuth.getUsers()

Obtém os dados do usuário correspondentes aos identificadores especificados.

Não há garantias de pedido; em particular, não é garantido que a enésima entrada na lista de resultados corresponda à enésima entrada na lista de parâmetros de entrada.

Apenas um máximo de 100 identificadores podem ser fornecidos. Se mais de 100 identificadores forem fornecidos, esse método gerará um FirebaseAuthError.

Assinatura:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

Parâmetros

Parâmetro	Tipo	Descrição
identificadores	Identificador de usuário []	Os identificadores usados para indicar quais registros de usuário devem ser retornados. Não deve ter mais de 100 entradas.

Retorna:

Promessa< GetUsersResult >

Uma promessa que resolve os registros de usuário correspondentes.

Exceções

FirebaseAuthError Se algum dos identificadores for inválido ou se mais de 100 identificadores forem especificados.

BaseAuth.importUsers()

Importa a lista de usuários fornecida para o Firebase Auth. É permitido importar no máximo 1.000 usuários, um de cada vez. Ao importar usuários com senhas, é necessário especificar UserImportOptions . Esta operação é otimizada para importações em massa e ignorará verificações de uid , email e outros identificadores exclusivos que podem resultar em duplicações.

Assinatura:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

Parâmetros

Parâmetro	Tipo	Descrição
Usuários	Registro de importação de usuário []	A lista de registros de usuário a serem importados para o Firebase Auth.
opções	Opções de importação de usuário	As opções de importação de usuários, necessárias quando os usuários fornecidos incluem credenciais de senha.

Retorna:

Promessa< UserImportResult >

Uma promessa que é resolvida quando a operação é concluída com o resultado da importação. Isto inclui o número de importações bem sucedidas, o número de importações falhadas e os seus erros correspondentes.

BaseAuth.listProviderConfigs()

Retorna a lista de configurações de provedor existentes que correspondem ao filtro fornecido. No máximo, 100 configurações de provedor podem ser listadas por vez.

O suporte do provedor SAML e OIDC 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 .

Assinatura:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

Parâmetros

Parâmetro	Tipo	Descrição
opções	AuthProviderConfigFilter	O filtro de configuração do provedor a ser aplicado.

Retorna:

Promessa< ListProviderConfigResults >

Uma promessa que é resolvida com a lista de configurações de provedores que atendem aos requisitos de filtro.

BaseAuth.listUsers()

Recupera uma lista de usuários (apenas lote único) com um tamanho de maxResults começando no deslocamento especificado por pageToken . Isso é usado para recuperar todos os usuários de um projeto especificado em lotes.

Consulte Listar todos os usuários para obter exemplos de código e documentação detalhada.

Assinatura:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

Parâmetros

Parâmetro	Tipo	Descrição
maxResultados	número	O tamanho da página, 1000 se indefinido. Este também é o limite máximo permitido.
token de página	corda	O token da próxima página. Se não for especificado, retorna usuários iniciando sem qualquer deslocamento.

Retorna:

Promessa< ListUsersResult >

Uma promessa que é resolvida com o lote atual de usuários baixados e o token da próxima página.

BaseAuth.revokeRefreshTokens()

Revoga todos os tokens de atualização de um usuário existente.

Esta API atualizará UserRecord.tokensValidAfterTime do usuário para o UTC atual. É importante que o servidor no qual isso é chamado tenha seu relógio acertado e sincronizado.

Embora isso revogue todas as sessões de um usuário especificado e desabilite a criação de novos tokens de ID para sessões existentes, os tokens de ID existentes podem permanecer ativos até sua expiração natural (uma hora). Para verificar se os tokens de ID foram revogados, use BaseAuth.verifyIdToken() onde checkRevoked está definido como verdadeiro.

Assinatura:

revokeRefreshTokens(uid: string): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
UID	corda	O `uid` correspondente ao usuário cujos tokens de atualização serão revogados.

Retorna:

Promessa<void>

Uma promessa vazia cumprida depois que os tokens de atualização do usuário forem revogados.

BaseAuth.setCustomUserClaims()

Define reivindicações adicionais do desenvolvedor sobre um usuário existente identificado pelo uid fornecido , normalmente usado para definir funções de usuário e níveis de acesso. Essas declarações devem ser propagadas para todos os dispositivos onde o usuário já estiver conectado (após a expiração do token ou quando a atualização do token for forçada) e na próxima vez que o usuário entrar. Se um nome de declaração OIDC reservado for usado (sub, iat, iss, etc. ), um erro é gerado. Eles são definidos no JWT do token de ID do usuário autenticado.

Consulte Definindo funções de usuário e níveis de acesso para exemplos de código e documentação detalhada.

Assinatura:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
UID	corda	O `uid` do usuário a ser editado.
customUserClaims	objeto \| nulo	O desenvolvedor afirma definir. Se null for passado, as declarações personalizadas existentes serão excluídas. Passar uma carga útil de declarações personalizadas maior que 1.000 bytes gerará um erro. As declarações personalizadas são adicionadas ao token de ID do usuário, que é transmitido em cada solicitação autenticada. Para atributos de usuário não relacionados ao acesso ao perfil, use banco de dados ou outros sistemas de armazenamento separados.

Retorna:

Promessa<void>

Uma promessa que é resolvida quando a operação é concluída com êxito.

BaseAuth.updateProviderConfig()

Retorna uma promessa que é resolvida com o AuthProviderConfig atualizado correspondente ao ID do provedor especificado. Se o ID especificado não existir, um erro auth/configuration-not-found será gerado.

O suporte do provedor SAML e OIDC 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 .

Assinatura:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

Parâmetros

Parâmetro	Tipo	Descrição
ID do provedor	corda	O ID do provedor correspondente à configuração do provedor a ser atualizada.
atualizadoConfig	AtualizaçãoAuthProviderRequest	A configuração atualizada.

Retorna:

Promessa< AuthProviderConfig >

Uma promessa que se resolve com a configuração atualizada do provedor.

BaseAuth.updateUser()

Atualiza um usuário existente.

Consulte Atualizar um usuário para obter exemplos de código e documentação detalhada.

Assinatura:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

Parâmetros

Parâmetro	Tipo	Descrição
UID	corda	O `uid` correspondente ao usuário a ser atualizado.
propriedades	Solicitação de atualização	As propriedades a serem atualizadas no usuário fornecido.

Retorna:

Promessa< UserRecord >

Uma promessa cumprida com os dados atualizados do usuário.

BaseAuth.verifyIdToken()

Verifica um token de ID do Firebase (JWT). Se o token for válido, a promessa será cumprida com as declarações decodificadas do token; caso contrário, a promessa será rejeitada.

Se checkRevoked estiver definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado. Se sim, um erro auth/user-disabled será gerado. Se não, verifica se a sessão correspondente ao ID token foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/id-token-revoked será lançado. Se não for especificado, a verificação não será aplicada.

Consulte Verificar tokens de ID para obter exemplos de código e documentação detalhada.

Assinatura:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parâmetros

Parâmetro	Tipo	Descrição
idToken	corda	O token de ID a ser verificado.
verificarRevogado	boleano	Se deve verificar se o token de ID foi revogado. Isso requer uma solicitação extra ao back-end do Firebase Auth para verificar o tempo `tokensValidAfterTime` do usuário correspondente. Quando não especificada, esta verificação adicional não é aplicada.

Retorna:

Promessa< DecodedIdToken >

Uma promessa cumprida com as declarações decodificadas do token se o token de ID for válido; caso contrário, uma promessa rejeitada.

BaseAuth.verifySessionCookie()

Verifica um cookie de sessão do Firebase. Retorna uma promessa com as reivindicações do cookie. Rejeita a promessa se o cookie não puder ser verificado.

Se checkRevoked for definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado: se sim, um erro auth/user-disabled é lançado. Se não, verifica se a sessão correspondente ao cookie de sessão foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/session-cookie-revoked será gerado. Se não for especificado, a verificação não será executada.

Consulte Verificar cookies de sessão para exemplos de código e documentação detalhada

Assinatura:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parâmetros

Parâmetro	Tipo	Descrição
sessãoCookie	corda	O cookie de sessão a ser verificado.
verificarRevogado	boleano

Retorna:

Promessa< DecodedIdToken >

Uma promessa cumprida com as declarações decodificadas do cookie de sessão se o cookie de sessão for válido; caso contrário, uma promessa rejeitada.