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, developerClaims) Cria um novo token personalizado (JWT) do Firebase que pode ser enviado de volta a um dispositivo cliente para fazer login com os métodos signInWithCustomToken() dos SDKs do cliente. (Instâncias com reconhecimento de locatário também incorporarão a ID do locatário no token.) Consulte Criar tokens personalizados para exemplos de código e documentação detalhada.
createProviderConfig(config) Retorna uma promessa que resolve com o AuthProviderConfig recém-criado quando a nova configuração do provedor é criada. O suporte do provedor SAML e OIDC 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 .
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 ser usada para gerenciamento de sessão. O cookie de sessão JWT terá as mesmas declarações de carga útil que o token de ID fornecido. Consulte Gerenciar cookies de sessão para obter exemplos de código e documentação detalhada.
criarUsuário(propriedades) Cria um novo usuário. Consulte Criar um usuário para 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, será gerado um erro auth/configuration-not-found . O suporte do provedor SAML e OIDC 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 .
deleteUser(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. A exclusão de um usuário inexistente não gerará um erro (ou seja, esse método é idempotente.) Os 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. No momento, essa API tem uma taxa limitada no servidor a 1 QPS. Se você exceder isso, poderá receber um erro de cota excedida. Portanto, se você deseja excluir mais de 1.000 usuários, pode ser necessário adicionar um atraso para garantir que não ultrapasse esse limite.
gerarEmailVerificationLink(email, actionCodeSettings) Gera o link de ação de e-mail fora da banda para verificar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings fornecido como um argumento para esse 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.
gerarPasswordResetLink(email, actionCodeSettings) Gera o link de ação de e-mail fora da 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 manipulado por um aplicativo móvel ou navegador e as informações de estado adicionais a serem passadas no link direto, etc.
generateSignInWithEmailLink(email, actionCodeSettings) Gera o link de ação de e-mail fora da banda para verificar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings fornecido como um argumento para esse 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 da banda para verificar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings fornecido como um argumento para esse 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 resolve com a configuração do provedor correspondente ao ID do provedor especificado. Se o ID especificado não existir, será gerado um erro auth/configuration-not-found . O suporte do provedor SAML e OIDC 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 .
getUsuário(uid) Obtém os dados do usuário correspondente a um determinado uid . Consulte Recuperar dados do usuário para obter exemplos de código e documentação detalhada.
getUserByEmail(email) Obtém os dados do usuário correspondente a um determinado email. Consulte Recuperar dados do usuário para obter exemplos de código e documentação detalhada.
getUserByPhoneNumber(phoneNumber) 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 obter 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 obter 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 pedidos; em particular, não é garantido que a n-ésima entrada na lista de resultados corresponda à n-é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. Um máximo de 1.000 usuários podem ser importados um por vez. Ao importar usuários com senhas, é necessário especificar UserImportOptions . Essa operação é otimizada para importações em massa e ignorará as verificações de uid , email e outros identificadores exclusivos que podem resultar em duplicações.
listProviderConfigs(opções) 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 o Identity Platform (GCIP) do Google Cloud. 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 um único lote) com um tamanho de maxResults a partir do deslocamento conforme 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.
revokeRefreshTokens(uid) Revoga todos os tokens de atualização de um usuário existente. Essa API atualizará o UserRecord.tokensValidAfterTime do usuário para o UTC atual. É importante que o servidor em que isso é chamado tenha seu relógio ajustado corretamente e sincronizado. Embora isso revogue todas as sessões para um usuário especificado e desative 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() em que checkRevoked está definido como true.
setCustomUserClaims(uid, customUserClaims) Define declarações de desenvolvedor adicionais em 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 se propagar para todos os dispositivos em que o usuário já está conectado (após a expiração do token ou quando a atualização do token é 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 é lançado. 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 obter exemplos de código e documentação detalhada.
updateProviderConfig(providerId, updatedConfig) Retorna uma promessa que resolve com o AuthProviderConfig atualizado correspondente ao ID do provedor especificado. Se o ID especificado não existir, será gerado um erro auth/configuration-not-found . O suporte do provedor SAML e OIDC 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 .
updateUser(uid, propriedades) Atualiza um usuário existente. Consulte Atualizar um usuário para obter exemplos de código e documentação detalhada.
verifiqueIdToken(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 é rejeitada. Se checkRevoked for definido como true, primeiro verifica se o usuário correspondente está desabilitado. Se sim, um erro auth/user-disabled é gerado. Se não, verifica se a sessão correspondente ao token de ID foi revogada. Se a sessão do usuário correspondente foi 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.
verifiqueSessionCookie(sessionCookie, checkRevoked) Verifica um cookie de sessão do Firebase. Retorna uma promessa com as declarações de cookies. Rejeita a promessa se o cookie não puder ser verificado. Se checkRevoked for definido como true, primeiro verifica se o usuário correspondente está desabilitado: Se sim, um erro auth/user-disabled é gerado. Se não, verifica se a sessão correspondente ao cookie de sessão foi revogada. Se a sessão do usuário correspondente foi invalidada, um erro auth/session-cookie-revoked é gerado. Se não for especificado, a verificação não é executada. Consulte Verificar cookies de sessão para exemplos de código e documentação detalhada

BaseAuth.createCustomToken()

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

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

Assinatura:

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

Parâmetros

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

Devoluções:

Promessa<string>

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

BaseAuth.createProviderConfig()

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

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

Assinatura:

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

Parâmetros

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

Devoluções:

Promessa< AuthProviderConfig >

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

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 ser usada para gerenciamento de sessão. O cookie de sessão JWT terá as mesmas declarações de carga útil 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 Modelo Descrição
idToken corda O token de ID do Firebase a ser trocado por um cookie de sessão.
sessionCookieOptions SessionCookieOptions As opções de cookie de sessão que incluem duração de sessão personalizada.

Devoluções:

Promessa<string>

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

BaseAuth.createUser()

Cria um novo usuário.

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

Assinatura:

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

Parâmetros

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

Devoluções:

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, será gerado um erro auth/configuration-not-found .

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

Assinatura:

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

Parâmetros

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

Devoluções:

Promessa<void>

Uma promessa que 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 Modelo Descrição
fluido corda O uid correspondente ao usuário a ser excluído.

Devoluções:

Promessa<void>

Uma promessa vazia cumprida depois que o usuário foi excluído.

BaseAuth.deleteUsers()

Exclui os usuários especificados pelos uids fornecidos.

A exclusão de um usuário inexistente não gerará um erro (ou seja, esse método é idempotente.) Os 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.

No momento, essa API tem uma taxa limitada no servidor a 1 QPS. Se você exceder isso, poderá receber um erro de cota excedida. Portanto, se você deseja excluir mais de 1.000 usuários, pode ser necessário adicionar um atraso para garantir que não ultrapasse esse limite.

Assinatura:

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

Parâmetros

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

Devoluções:

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.

Gera o link de ação de e-mail fora da banda para verificar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings fornecido como um argumento para esse 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 Modelo Descrição
o email corda A conta de e-mail a ser verificada.
actionCodeSettings Configurações do ActionCode As configurações do código de ação. Se especificado, a URL de estado/continuação é definida como o parâmetro "continueUrl" no link de verificação de email. A página de destino de verificação de e-mail padrão usará isso para exibir um link para voltar ao aplicativo se estiver instalado. Se actionCodeSettings não for especificado, nenhuma URL será anexada à URL da ação. A URL de estado fornecida deve pertencer a um domínio que esteja na lista de permissões do desenvolvedor no console. Caso contrário, um erro é lançado. Os redirecionamentos de aplicativos para dispositivos móveis só sã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 são respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Devoluções:

Promessa<string>

Uma promessa que 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
    });

Gera o link de ação de e-mail fora da 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 manipulado por um aplicativo móvel ou navegador e as informações de estado adicionais a serem passadas no link direto, etc.

Assinatura:

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

Parâmetros

Parâmetro Modelo Descrição
o email corda O endereço de e-mail do usuário cuja senha deve ser redefinida.
actionCodeSettings Configurações do ActionCode As configurações do código de ação. Se especificado, a URL de estado/continuação é definida como o parâmetro "continueUrl" no link de redefinição de senha. A página de destino de redefinição de senha padrão usará isso para exibir um link para voltar ao aplicativo se estiver instalado. Se actionCodeSettings não for especificado, nenhuma URL será anexada à URL da ação. A URL de estado fornecida deve pertencer a um domínio que esteja na lista de permissões do desenvolvedor no console. Caso contrário, um erro é lançado. Os redirecionamentos de aplicativos para dispositivos móveis só sã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 são respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Devoluções:

Promessa<string>

Uma promessa que 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
    });

Gera o link de ação de e-mail fora da banda para verificar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings fornecido como um argumento para esse 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:

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

Parâmetros

Parâmetro Modelo Descrição
o email corda A conta de e-mail a ser verificada.
actionCodeSettings Configurações do ActionCode As configurações do código de ação. Se especificado, a URL de estado/continuação é definida como o parâmetro "continueUrl" no link de verificação de email. A página de destino de verificação de e-mail padrão usará isso para exibir um link para voltar ao aplicativo se estiver instalado. Se actionCodeSettings não for especificado, nenhuma URL será anexada à URL da ação. A URL de estado fornecida deve pertencer a um domínio que esteja na lista de permissões do desenvolvedor no console. Caso contrário, um erro é lançado. Os redirecionamentos de aplicativos para dispositivos móveis só sã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 são respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Devoluções:

Promessa<string>

Uma promessa que 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
    });

Gera um link de ação de e-mail fora da banda para verificar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings fornecido como um argumento para esse 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 Modelo Descrição
o email corda A conta de e-mail atual.
Novo Email corda O endereço de e-mail para o qual a conta está sendo atualizada.
actionCodeSettings Configurações do ActionCode As configurações do código de ação. Se especificado, a URL de estado/continuação é definida como o parâmetro "continueUrl" no link de verificação de email. A página de destino de verificação de e-mail padrão usará isso para exibir um link para voltar ao aplicativo se estiver instalado. Se actionCodeSettings não for especificado, nenhuma URL será anexada à URL da 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ó sã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 são respeitados somente se estiverem configurados no mesmo projeto do Firebase Auth.

Devoluções:

Promessa<string>

Uma promessa que resolve com o link gerado.

BaseAuth.getProviderConfig()

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

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

Assinatura:

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

Parâmetros

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

Devoluções:

Promessa< AuthProviderConfig >

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

BaseAuth.getUser()

Obtém os dados do usuário para o usuário correspondente a um determinado uid .

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

Assinatura:

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

Parâmetros

Parâmetro Modelo Descrição
fluido corda O uid correspondente ao usuário cujos dados devem ser buscados.

Devoluções:

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 obter exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

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

Devoluções:

Promessa < UserRecord >

Uma promessa cumprida com os dados do usuário correspondentes ao e-mail 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 obter exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

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

Devoluções:

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 obter exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

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

Devoluções:

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 pedidos; em particular, não é garantido que a n-ésima entrada na lista de resultados corresponda à n-é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 Modelo Descrição
identificadores UserIdentifier [] Os identificadores usados ​​para indicar quais registros de usuário devem ser retornados. Não deve ter mais de 100 entradas.

Devoluções:

Promessa< GetUsersResult >

Uma promessa que resolve para 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. Um máximo de 1.000 usuários podem ser importados um por vez. Ao importar usuários com senhas, é necessário especificar UserImportOptions . Esta operação é otimizada para importações em massa e ignorará as verificações de uid , e- email e outros identificadores exclusivos que podem resultar em duplicações.

Assinatura:

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

Parâmetros

Parâmetro Modelo 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 do usuário, necessárias quando os usuários fornecidos incluem credenciais de senha.

Devoluções:

Promessa< UserImportResult >

Uma promessa que resolve quando a operação é concluída com o resultado da importação. Isso inclui o número de importações bem-sucedidas, o número de importações com falha e 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 o Identity Platform (GCIP) do Google Cloud. 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 Modelo Descrição
opções AuthProviderConfigFilter O filtro de configuração do provedor a ser aplicado.

Devoluções:

Promessa< ListProviderConfigResults >

Uma promessa que resolve com a lista de configurações de provedor que atendem aos requisitos de filtro.

BaseAuth.listUsers()

Recupera uma lista de usuários (somente lote único) com um tamanho de maxResults a partir do deslocamento conforme 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 Modelo Descrição
maxResults número O tamanho da página, 1000 se indefinido. Este também é o limite máximo permitido.
pageToken corda O próximo token de página. Se não for especificado, retorna usuários iniciando sem nenhum deslocamento.

Devoluções:

Promessa< ListUsersResult >

Uma promessa que resolve 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.

Essa API atualizará o UserRecord.tokensValidAfterTime do usuário para o UTC atual. É importante que o servidor em que isso é chamado tenha seu relógio ajustado corretamente e sincronizado.

Embora isso revogue todas as sessões para um usuário especificado e desative 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() em que checkRevoked está definido como true.

Assinatura:

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

Parâmetros

Parâmetro Modelo Descrição
fluido corda O uid correspondente ao usuário cujos tokens de atualização devem ser revogados.

Devoluções:

Promessa<void>

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

BaseAuth.setCustomUserClaims()

Define declarações adicionais do desenvolvedor em 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 se propagar para todos os dispositivos em que o usuário já está conectado (após a expiração do token ou quando a atualização do token é 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 é lançado. 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 obter exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro Modelo Descrição
fluido corda O uid do usuário a ser editado.
Reivindicações personalizadas do usuário objeto | nulo O desenvolvedor afirma definir. Se null for passado, as declarações personalizadas existentes serão excluídas. Passar uma carga 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 de perfil, use banco de dados ou outros sistemas de armazenamento separados.

Devoluções:

Promessa<void>

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

BaseAuth.updateProviderConfig()

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

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

Assinatura:

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

Parâmetros

Parâmetro Modelo Descrição
ID do provedor corda A ID do provedor correspondente à configuração do provedor a ser atualizada.
configuração atualizada UpdateAuthProviderRequest A configuração atualizada.

Devoluções:

Promessa< AuthProviderConfig >

Uma promessa que 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 Modelo Descrição
fluido 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.

Devoluções:

Promessa < UserRecord >

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

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 é rejeitada.

Se checkRevoked for definido como true, primeiro verifica se o usuário correspondente está desabilitado. Se sim, um erro auth/user-disabled é gerado. Se não, verifica se a sessão correspondente ao token de ID foi revogada. Se a sessão do usuário correspondente foi 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.

Assinatura:

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

Parâmetros

Parâmetro Modelo Descrição
idToken corda O token de ID a ser verificado.
checkRevogado 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 de tokensValidAfterTime para o usuário correspondente. Quando não especificado, essa verificação adicional não é aplicada.

Devoluções:

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 declarações de cookies. Rejeita a promessa se o cookie não puder ser verificado.

Se checkRevoked for definido como true, primeiro verifica se o usuário correspondente está desabilitado: Se sim, um erro auth/user-disabled é gerado. Se não, verifica se a sessão correspondente ao cookie de sessão foi revogada. Se a sessão do usuário correspondente foi invalidada, um erro auth/session-cookie-revoked é gerado. Se não for especificado, a verificação não é 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 Modelo Descrição
cookie de sessão corda O cookie de sessão a ser verificado.
checkRevogado boleano

Devoluções:

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.