firebase-admin.auth package

Autenticação Firebase.

Funções

Aulas

Interfaces

Aliases de tipo

getAuth()

Obtém o serviço Auth para o aplicativo padrão ou um determinado aplicativo.

getAuth() pode ser chamado sem argumentos para acessar o serviço Auth do aplicativo padrão ou como getAuth(app) para acessar o serviço Auth associado a um aplicativo específico.

Assinatura:

export declare function getAuth(app?: App): Auth;

Parâmetros

Retorna:

Autenticação

Exemplo 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

Exemplo 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

AuthFactorType

Identifica um segundo tipo de fator.

Assinatura:

export type AuthFactorType = 'phone';

AuthProviderConfig

O tipo de configuração do provedor de autenticação. BaseAuth.createProviderConfig() .

Assinatura:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CriarMultiFactorInfoRequest

Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um CreateRequest .

Assinatura:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CriarTenantRequest

Interface que representa as propriedades a serem definidas em um novo locatário.

Assinatura:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

Assinatura:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

MultiFactorConfigState

Identifica um estado de configuração multifator.

Assinatura:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

PasswordPolicyEnforcementState

O estado de aplicação de uma política de senha.

Assinatura:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RecaptchaAção

As ações a serem tomadas para solicitações protegidas por reCAPTCHA. - 'BLOCK': A solicitação protegida por reCAPTCHA será bloqueada.

Assinatura:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

O tipo de plataforma da chave.

Assinatura:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState

Estado de aplicação da proteção reCAPTCHA. - 'OFF': Não aplicado. - 'AUDITORIA': Crie avaliação, mas não imponha o resultado. - 'ENFORCE': Crie avaliação e imponha o resultado.

Assinatura:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig

A interface de solicitação para atualizar uma configuração de região SMS. Configura as regiões onde os usuários têm permissão para enviar SMS de verificação. Isto se baseia no código de chamada do número de telefone de destino.

Assinatura:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

AtualizaçãoAuthProviderRequest

Assinatura:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

AtualizarMultiFactorInfoRequest

Tipo que representa as propriedades de um segundo fator registrado pelo usuário para um UpdateRequest .

Assinatura:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identificador de usuário

Identifica um usuário a ser consultado.

Assinatura:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;