Interface mãe comum para as 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 do Firebase (JWT) que pode ser enviado de volta a um dispositivo cliente para fazer login com os métodos signInWithCustomToken() dos SDKs do cliente. As instâncias com reconhecimento de locatário também incorporam o ID do locatário no token.Consulte Criar tokens personalizados para exemplos de código e documentação detalhada. |
|
| createProviderConfig(config) (em inglês) | Retorna uma promessa que é resolvida com o AuthProviderConfig recém-criado quando a nova configuração do provedor é criada.O suporte ao 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. Essa string pode ser definida como um cookie de sessão do lado do servidor com uma política de cookies personalizada e usada para o gerenciamento da sessão. 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 exemplos de código e documentação detalhada. | |
| createUser(propriedades) | Cria um novo usuário.Consulte Criar um usuário para conferir exemplos de código e documentação detalhada. | |
| deleteProviderConfig(providerId) | 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. |
|
| deleteUser(uid) | Exclui um usuário existente.Consulte Excluir um usuário para ver exemplos de código e documentação detalhada. | |
| deleteUsers(uids) (link em inglês) | Exclui os usuários especificados pelos UIDs fornecidos.A exclusão de um usuário não existente não gera um erro (ou seja, esse método é idempotente.) Usuários não existentes são considerados excluídos com sucesso e, portanto, são contabilizados no valor DeleteUsersResult.successCount.É possível fornecer no máximo 1.000 identificadores. Se mais de 1.000 identificadores forem fornecidos, esse método vai gerar um FirebaseAuthError.No momento, essa API tem limitação de taxa no servidor a 1 QPS. Se você exceder esse limite, poderá receber um erro de cota excedida. Portanto, se você quiser excluir mais de mil usuários, adicione um atraso para não ultrapassar esse limite. |
|
| generateEmailVerificationLink(email, actionCodeSettings) | Gera o link de ação de email fora de banda para confirmar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings, fornecido como argumento para esse método, define se o link será processado por um aplicativo ou navegador para dispositivos móveis com informações adicionais de estado a serem transmitidas 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 será processado por um aplicativo ou navegador para dispositivos móveis e as informações adicionais de estado a serem transmitidas no link direto etc. | |
| generateSignInWithEmailLink(email, actionCodeSettings) | Gera o link de ação de email fora de banda para confirmar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings, fornecido como argumento para esse método, define se o link será processado por um aplicativo ou navegador para dispositivos móveis com informações adicionais de estado a serem transmitidas no link direto etc. | |
| generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) | Gera um link de ação de e-mail fora de banda para confirmar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings, fornecido como argumento para esse método, define se o link será processado por um aplicativo ou navegador para dispositivos móveis com informações adicionais de estado a serem transmitidas no link direto etc. | |
| getProviderConfig(providerId) (link em inglês) | Procura uma configuração de provedor do Auth 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. |
|
| getUser(uid) (link em inglês) | Extrai os dados do usuário correspondentes a um determinado uid.Consulte Recuperar dados do usuário para conferir exemplos de código e documentação detalhada. |
|
| getUserByEmail(e-mail) | Extrai os dados do usuário correspondentes a um determinado e-mail.Consulte Recuperar dados do usuário para conferir exemplos de código e documentação detalhada. | |
| getUserByOperator(phoneNumber) (link em inglês) | Acessa os dados do usuário correspondentes 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 exemplos de código e documentação detalhada. | |
| getUserByProviderUid(providerId, uid) | Extrai os dados do usuário correspondentes a um determinado ID de provedor.Consulte Recuperar dados do usuário para exemplos de código e documentação detalhada. | |
| getUsers(identifiers) | Extrai os dados do usuário correspondentes aos identificadores especificados.Não há garantias de ordem. Especificamente, a enésima entrada na lista de resultados não garante que 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 vai gerar um FirebaseAuthError. | |
| importUsers(users, options) | 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 devem ser especificadas. Esta operação é otimizada para importações em massa e vai ignorar as verificações de uid, email e outros identificadores de exclusividade, o que pode resultar em duplicações. |
|
| listProviderConfigs(options) (em inglês) | Retorna a lista de configurações de 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. | |
| listUsers(maxResults, pageToken) | 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 exemplos de código e documentação detalhada. |
|
| revokeRefreshTokens(uid) (link em inglês) | Revoga todos os tokens de atualização de um usuário existente.Esta API atualizará o UserRecord.tokensValidAfterTime do usuário para a UTC atual. É importante que o servidor em que ela é chamada tenha o relógio definido e sincronizado corretamente.Embora isso revogue todas as sessões de 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é 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. |
|
| setCustomUserClaims(uid, customUserClaims) | Define outras declarações de desenvolvedor sobre um usuário identificado pelo uid fornecido, normalmente usado para definir as funções e os níveis de acesso do usuário. Essas declarações precisam ser propagadas para todos os dispositivos em que o usuário já fez login (após a expiração do token ou quando a atualização dele é forçada) e na próxima vez que o usuário fizer login. Se um nome de declaração OIDC reservado for usado (sub, iat, iss etc.), será gerado um erro. Eles são definidos no JWT do token de ID do usuário autenticado.Consulte Como definir funções do usuário e níveis de acesso para amostras de código e documentação detalhada. |
|
| updateProviderConfig(providerId, updatedConfig) (em inglês) | 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. |
|
| updateUser(uid, properties) | Atualiza um usuário existente.Consulte Atualizar um usuário para acessar exemplos de código e documentação detalhada. | |
| verifyIdToken(idToken, checkrenewd) (link em inglês) | Verifica um token de código 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á rejeitada.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 especificado, a verificação não será aplicada.Consulte Verificar tokens de ID para conferir exemplos de código e documentação detalhada. |
|
| verifySessionCookie(sessionCookie, checkDeployd) | Verifica um cookie de sessão do Firebase. Retorna uma promessa com as declarações de cookies. Rejeita a promessa se não for possível verificar o cookie.Se checkRevoked for definido como verdadeiro, primeiro verifica se o usuário correspondente está desativado. Se sim, um erro auth/user-disabled será gerado. Em caso negativo, verifica se a sessão correspondente ao cookie da 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á realizada.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 fazer login com os métodos signInWithCustomToken() dos SDKs do cliente. As instâncias com reconhecimento de locatário também incorporam o ID do locatário no token.
Consulte Criar tokens personalizados para acessar exemplos de código e documentação detalhada.
Assinatura:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | string | O uid a ser usado como assunto do token personalizado. |
| developerClaims | objeto | Declarações adicionais opcionais a serem incluídas no payload do token personalizado. |
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 nova configuração do provedor é criada.
O suporte ao provedor de 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| config | AuthProviderConfig (em inglês) | 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. Essa string pode ser definida como um cookie de sessão do lado do servidor com uma política de cookies personalizada e usada para o gerenciamento da sessão. 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 conferir exemplos de código e documentação detalhada.
Assinatura:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idToken | string | O token de ID do Firebase para trocar por um cookie de sessão. |
| sessionCookieOptions | SessionCookieOptions (em inglês) | As opções de cookie da sessão que incluem a duração da sessão personalizada. |
Retorna:
Promessa<string>
Uma promessa que será resolvida com 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 | Tipo | Descrição |
|---|---|---|
| do bucket | CreateRequest (link em inglês) | As propriedades a serem definidas no novo registro do usuário a ser criado. |
Retorna:
Prometer<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 de 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| providerId | string | O ID do provedor correspondente à configuração do provedor a ser excluída. |
Retorna:
Promessa<void>
Uma promessa que é resolvida após a conclusão.
BaseAuth.deleteUser()
Exclui um usuário existente.
Consulte Excluir um usuário para exemplos de código e documentação detalhada.
Assinatura:
deleteUser(uid: string): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | string | 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.
A exclusão de um usuário não existente não gera um erro (ou seja, esse método é idempotente). Os usuários não existentes são considerados excluídos com sucesso e, portanto, são contabilizados no valor DeleteUsersResult.successCount.
É possível fornecer até 1.000 identificadores. Se mais de 1.000 identificadores forem fornecidos, esse método vai gerar um FirebaseAuthError.
No momento, essa API tem limitação de taxa no servidor a 1 QPS. Se você exceder esse limite, poderá receber um erro de cota excedida. Portanto, se você quiser excluir mais de mil usuários, adicione um atraso para não ultrapassar esse limite.
Assinatura:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| UIDs | string[] | O uids correspondente aos usuários a serem excluídos. |
Retorna:
Prometer<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 às exclusões com falha.
BaseAuth.generateEmailVerificationLink()
Gera o link de ação de email fora de banda para confirmar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings, fornecido como argumento para esse método, define se o link será processado por um aplicativo ou navegador para dispositivos móveis com informações adicionais de estado a serem transmitidas no link direto etc.
Assinatura:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| string | A conta de e-mail a ser verificada. | |
| actionCodeSettings | ActionCodeSettings. | Configurações do código de ação. Se especificado, o URL de estado/continuação é definido como o parâmetro "continueUrl" no link de verificação de e-mail. A página de destino padrão de verificação de e-mail 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 do estado fornecido precisa pertencer a um domínio autorizado pelo desenvolvedor no console. Valores maiores geram erro. Os redirecionamentos de apps 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 são respeitados apenas se estiverem configurados no mesmo projeto do Firebase Auth. |
Retorna:
Promessa<string>
Uma promessa que é resolvida 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 será processado por um aplicativo ou navegador para dispositivos móveis e as informações adicionais de estado a serem transmitidas no link direto etc.
Assinatura:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| string | O endereço de e-mail do usuário cuja senha será redefinida. | |
| actionCodeSettings | ActionCodeSettings. | Configurações do código de ação. Se especificado, o URL de estado/continuação é definido como o parâmetro "continueUrl" no link de redefinição de senha. A página de destino de redefinição de senha padrão vai usar isso para mostrar um link para voltar ao app, se ele estiver instalado. Se actionCodeSettings não for especificado, nenhum URL será anexado ao URL de ação. O URL do estado fornecido precisa pertencer a um domínio autorizado pelo desenvolvedor no console. Valores maiores geram erro. Os redirecionamentos de apps 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 são respeitados apenas se estiverem configurados no mesmo projeto do Firebase Auth. |
Retorna:
Promessa<string>
Uma promessa que é resolvida 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 email fora de banda para confirmar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings, fornecido como argumento para esse método, define se o link será processado por um aplicativo ou navegador para dispositivos móveis com informações adicionais de estado a serem transmitidas no link direto etc.
Assinatura:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| string | A conta de e-mail a ser verificada. | |
| actionCodeSettings | ActionCodeSettings. | Configurações do código de ação. Se especificado, o URL de estado/continuação é definido como o parâmetro "continueUrl" no link de verificação de e-mail. A página de destino padrão de verificação de e-mail 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 do estado fornecido precisa pertencer a um domínio autorizado pelo desenvolvedor no console. Valores maiores geram erro. Os redirecionamentos de apps 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 são respeitados apenas se estiverem configurados no mesmo projeto do Firebase Auth. |
Retorna:
Promessa<string>
Uma promessa que é resolvida 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 confirmar a propriedade do usuário do e-mail especificado. O objeto ActionCodeSettings, fornecido como argumento para esse método, define se o link será processado por um aplicativo ou navegador para dispositivos móveis com informações adicionais de estado a serem transmitidas no link direto etc.
Assinatura:
generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| string | A conta de e-mail atual. | |
| novoE-mail | string | O endereço de e-mail para o qual a conta está sendo atualizada. |
| actionCodeSettings | ActionCodeSettings. | Configurações do código de ação. Se especificado, o URL de estado/continuação é definido como o parâmetro "continueUrl" no link de verificação de e-mail. A página de destino padrão de verificação de e-mail 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 precisa pertencer a um domínio autorizado no console. Caso contrário, um erro será gerado. Os redirecionamentos de apps 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 são respeitados apenas se estiverem configurados no mesmo projeto do Firebase Auth. |
Retorna:
Promessa<string>
Uma promessa que é resolvida com o link gerado.
BaseAuth.getProviderConfig()
Procura uma configuração de provedor do Auth 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 de 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| providerId | string | O ID do provedor correspondente à configuração do provedor a ser retornada. |
Retorna:
Promessa<AuthProviderConfig>
Uma promessa que é resolvida com a configuração correspondente ao ID fornecido.
BaseAuth.getUser()
Extrai os dados do usuário correspondentes a um determinado uid.
Consulte Recuperar dados do usuário para conferir exemplos de código e documentação detalhada.
Assinatura:
getUser(uid: string): Promise<UserRecord>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | string | O uid correspondente ao usuário cujos dados serão buscados. |
Retorna:
Prometer<UserRecord>
Uma promessa cumprida com os dados do usuário correspondentes aos uid fornecidos.
BaseAuth.getUserByEmail()
Recebe os dados do usuário correspondentes a um determinado e-mail.
Consulte Recuperar dados do usuário para conferir exemplos de código e documentação detalhada.
Assinatura:
getUserByEmail(email: string): Promise<UserRecord>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| string | O e-mail correspondente ao usuário cujos dados serão buscados. |
Retorna:
Prometer<UserRecord>
Uma promessa cumprida com os dados do usuário correspondentes ao e-mail informado.
BaseAuth.getUserByPhoneNumber()
Acessa os dados do usuário correspondentes 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 conferir 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 | string | O número de telefone correspondente ao usuário cujos dados serão buscados. |
Retorna:
Prometer<UserRecord>
Uma promessa cumprida com os dados do usuário correspondentes ao número de telefone informado.
BaseAuth.getUserByProviderUid()
Recebe os dados do usuário correspondentes a um determinado ID de provedor.
Consulte Recuperar dados do usuário para conferir exemplos de código e documentação detalhada.
Assinatura:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| providerId | string | O ID do provedor do Google, por exemplo, "google.com". |
| uid | string | O identificador do usuário do provedor em questão. |
Retorna:
Prometer<UserRecord>
Uma promessa cumprida com os dados do usuário correspondentes ao ID do provedor.
BaseAuth.getUsers()
Recebe os dados do usuário correspondentes aos identificadores especificados.
Não há garantias de ordenação; em particular, a enésima entrada na lista de resultados não tem garantia de corresponder à enésima entrada na lista de parâmetros de entrada.
É possível fornecer no máximo 100 identificadores. Se mais de 100 identificadores forem fornecidos, esse método vai gerar um FirebaseAuthError.
Assinatura:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| identifiers | UserIdentifier[] | Os identificadores usados para indicar quais registros de usuário devem ser retornados. Não pode ter mais de 100 entradas. |
Retorna:
Prometer<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 devem ser especificadas. Esta operação é otimizada para importações em massa e vai ignorar as verificações de uid, email e outra exclusividade de identificador, o que pode resultar em duplicações.
Assinatura:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| usuários | UserImportRecord[] | A lista de registros de usuários a serem importados para o Firebase Auth. |
| do modelo. | UserImportOptions (em inglês) | As opções de importação de usuários, obrigatórias quando os usuários fornecidos incluem credenciais de senha. |
Retorna:
Prometer<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, de importações com falha e os erros correspondentes.
BaseAuth.listProviderConfigs()
Retorna a lista de configurações de provedor existentes que correspondem ao filtro fornecido. É possível listar até 100 configurações de provedor por vez.
O suporte ao provedor de 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| do modelo. | AuthProviderConfigFilter (link em inglês) | O filtro de configuração do provedor a ser aplicado. |
Retorna:
Promessa<ListProviderConfigResults>
Uma promessa que é resolvida com a lista de configurações do 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. É usado para recuperar todos os usuários de um projeto especificado em lotes.
Consulte Listar todos os usuários para exemplos de código e documentação detalhada.
Assinatura:
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| maxResults | number | O tamanho da página, 1.000, se indefinido. Esse também é o limite máximo permitido. |
| pageToken | string | O token da próxima página. Se não for especificado, retorna os usuários começando sem nenhum deslocamento. |
Retorna:
Prometer<ListUsersResult>
Uma promessa que é resolvida com o lote atual de usuários transferidos por download e o token da próxima página.
BaseAuth.revokeRefreshTokens()
Revoga todos os tokens de atualização de um usuário.
Essa API vai atualizar o UserRecord.tokensValidAfterTime do usuário para o UTC atual. É importante que o servidor em que ela é chamada tenha o relógio definido corretamente e sincronizado.
Embora isso revogue todas as sessões de 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é 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | string | O uid correspondente ao usuário cujos tokens de atualização serão revogados. |
Retorna:
Promessa<void>
Uma promessa vazia cumprida assim que os tokens de atualização do usuário são revogados.
BaseAuth.setCustomUserClaims()
Define outras declarações de desenvolvedor sobre um usuário identificado pelo uid fornecido, normalmente usado para definir as funções e os níveis de acesso do usuário. Essas declarações precisam ser propagadas para todos os dispositivos em que o usuário já fez login (após a expiração do token ou quando a atualização dele é forçada) e na próxima vez que o usuário fizer login. Se um nome de declaração OIDC reservado for usado (sub, iat, iss etc.), será gerado um erro. Eles são definidos no JWT do token de ID do usuário autenticado.
Consulte Como definir funções do usuário e níveis de acesso para consultar exemplos de código e uma documentação detalhada.
Assinatura:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | string | O uid do usuário a ser editado. |
| customUserClaims | objeto | nulo | O desenvolvedor afirma definir. Se nulo for transmitido, as declarações personalizadas existentes serão excluídas. Transmitir um payload de declarações personalizadas com mais de 1.000 bytes causará um erro. As declarações personalizadas são adicionadas ao token de ID do usuário, que é transmitido em todas as solicitações autenticadas. Para atributos de usuário relacionados ao perfil não relacionados ao acesso, use o banco de dados ou outros sistemas de armazenamento separados. |
Retorna:
Promessa<void>
Uma promessa que será resolvida quando a operação for 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, será gerado um erro auth/configuration-not-found.
O suporte ao provedor de 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| providerId | string | O ID do provedor correspondente à configuração do provedor a ser atualizada. |
| updateConfig | UpdateAuthProviderRequest (em inglês) | A configuração atualizada. |
Retorna:
Promessa<AuthProviderConfig>
Uma promessa que é resolvida com a configuração do provedor atualizada.
BaseAuth.updateUser()
Atualiza um usuário existente.
Consulte Atualizar um usuário para exemplos de código e documentação detalhada.
Assinatura:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | string | O uid correspondente ao usuário a ser atualizado. |
| do bucket | UpdateRequest (link em inglês) | As propriedades a serem atualizadas no usuário fornecido. |
Retorna:
Prometer<UserRecord>
Uma promessa cumprida com os dados atualizados do usuário.
BaseAuth.verifyIdToken()
Verifica um token de código 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á rejeitada.
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 especificado, a verificação não será aplicada.
Consulte Verificar tokens de ID para acessar exemplos de código e documentação detalhada.
Assinatura:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idToken | string | O token de ID a ser verificado. |
| checkRevogard | booleano | Define se o token de ID foi revogado. Isso requer uma solicitação extra ao back-end do Firebase Auth para verificar o horário do tokensValidAfterTime para o usuário correspondente. Quando não é especificada, essa verificação adicional não é aplicada. |
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 recusada.
BaseAuth.verifySessionCookie()
Verifica um cookie de sessão do Firebase. Retorna uma promessa com as declarações de cookies. 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 da 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á realizada.
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 | string | O cookie de sessão a ser verificado. |
| checkRevogard | booleano |
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 recusada.