BaseAuth class

Interface pai comum para as APIs Auth e TenantAwareAuth.

Assinatura:

export declare abstract class BaseAuth 

Métodos

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 SDKs do cliente. signInWithCustomToken(). As instâncias com reconhecimento de locatário também incorporarão o ID de locatário ao token.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<string>

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

BaseAuth.createProviderConfig()

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

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<AuthProviderConfig>

Uma promessa que se 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 servidor com uma política de cookies personalizada e ser usada no gerenciamento de sessões. O JWT do cookie de sessão terá as mesmas declarações de payload que o token de ID fornecido.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<string>

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

BaseAuth.createUser()

Cria um novo usuário.

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

Assinatura:

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

Parâmetros

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 transmitido. Se o ID especificado não existir, será gerado um erro auth/configuration-not-found.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma promessa que se resolve na conclusão.

BaseAuth.deleteUser()

Exclui um usuário existente.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

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

BaseAuth.deleteUsers()

Exclui os usuários especificados pelos uid fornecidos.

Excluir um usuário não existente não gera um erro (ou seja, este método é idempotente). Os usuários não existentes são considerados excluídos e, portanto, contabilizados no valor DeleteUsersResult.successCount.

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

No momento, essa API está limitada por taxa no servidor a 1 QPS. Se você ultrapassar esse valor, poderá receber um erro de cota excedida. Portanto, se quiser excluir mais de mil usuários, talvez seja necessário adicionar um atraso para não ultrapassar esse limite.

Assinatura:

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

Parâmetros

Retorna:

Promessa<DeleteUsersResult>

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

BaseAuth.generateEmailVerificaçãoLink()

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 um argumento para esse método define se o link deve ser tratado por um app ou navegador para dispositivos móveis, além de outras informações de estado que serão transmitidas no link direto etc.

Assinatura:

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

Parâmetros

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 app ou navegador para dispositivos móveis, além das informações de estado adicionais que serão transmitidas no link direto etc.

Assinatura:

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

Parâmetros

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

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 um argumento para esse método define se o link deve ser tratado por um app ou navegador para dispositivos móveis, além de outras informações de estado que serão transmitidas no link direto etc.

Assinatura:

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

Parâmetros

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 um argumento para esse método define se o link deve ser tratado por um app ou navegador para dispositivos móveis, além de outras informações de estado que serão transmitidas no link direto etc.

Assinatura:

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

Parâmetros

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

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<AuthProviderConfig>

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

BaseAuth.getUser()

Recebe os dados do usuário correspondente a um determinado uid.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<UserRecord>

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

BaseAuth.getUserByEmail()

Extrai os dados do usuário correspondente a um determinado e-mail.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<UserRecord>

Uma promessa cumprida com os dados do usuário correspondentes ao e-mail fornecido.

BaseAuth.getUserBytivo()

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

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<UserRecord>

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

BaseAuth.getUserByProviderUid()

Recebe os dados do usuário correspondente a um determinado ID de provedor.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<UserRecord>

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

BaseAuth.getUsers()

Recebe os dados do usuário correspondentes aos identificadores especificados.

Não há garantias de ordenação; Especificamente, não há garantia de que a enésima entrada na lista de resultados corresponda à enésima entrada na lista de parâmetros de entrada.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<GetUsersResult>

Uma promessa que é resolvida com os registros do 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. No máximo 1.000 usuários podem ser importados, um de cada vez. Ao importar usuários com senhas, UserImportOptions precisam ser especificados. Esta operação é otimizada para importações em massa e ignora as verificações em uid, email e outras exclusividades de identificador, que podem resultar em duplicações.

Assinatura:

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

Parâmetros

Retorna:

Promessa<UserImportResult>

Uma promessa que é resolvida 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 os erros correspondentes.

BaseAuth.listProviderConfigs()

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

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<ListProviderConfigResults>

Uma promessa que se 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 começando pelo deslocamento especificado por pageToken. É usado para recuperar todos os usuários de um projeto especificado em lotes.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<ListUsersResult>

Uma promessa que se 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 relógio do servidor em que ele é chamado esteja configurado e sincronizado.

Embora isso revogue todas as sessões de um usuário específico e desative a criação de novos tokens de ID de sessões existentes, os tokens de ID existentes podem permanecer ativos até a expiração natural (uma hora). Para verificar se os tokens de ID foram revogados, use BaseAuth.verifyIdToken() em que checkRevoked esteja definido como verdadeiro.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

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

BaseAuth.setCustomUserClaims()

Define outras declarações do desenvolvedor sobre um usuário identificado pelo uid fornecido. Normalmente, ele é usado para definir as funções do usuário e os níveis de acesso. Essas declarações precisam ser propagadas para todos os dispositivos em que o usuário já tiver feito login (após a expiração do token ou quando a atualização dele for forçada) e na próxima vez que ele fizer login. Se um nome de declaração do OIDC reservado for usado (sub, iat, iss etc.), um erro será gerado. Elas são definidas no JWT do token de ID do usuário autenticado.

Consulte Como definir papéis do usuário e níveis de acesso para ver exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

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

BaseAuth.updateProviderConfig()

Retorna uma promessa que é resolvida 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 ao provedor SAML e OIDC 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.

Assinatura:

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

Parâmetros

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

Assinatura:

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

Parâmetros

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á atendida com as declarações decodificadas do token. Caso contrário, a promessa será recusada.

Se checkRevoked for definido como verdadeiro, primeiro vai verificar se o usuário correspondente está desativado. Em caso afirmativo, um erro auth/user-disabled será gerado. Em caso negativo, verifica se a sessão correspondente ao token de ID foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/id-token-revoked será gerado. Se não for especificada, a verificação não será aplicada.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<DeencodedIdToken>

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 do cookie. Rejeita a promessa se não for possível verificar o cookie.

Se checkRevoked for definido como verdadeiro, primeiro vai verificar se o usuário correspondente está desativado. Em caso afirmativo, um erro auth/user-disabled será gerado. Em caso negativo, 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 especificada, a verificação não será realizada.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<DeencodedIdToken>

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.