firebase-admin.auth package

Autenticazione Firebase.

Funzioni

Classi

Interfacce

Digitare Alias

getAuth()

Ottiene il servizio di autenticazione per l'app predefinita o per una determinata app.

getAuth() può essere chiamato senza argomenti per accedere al servizio di autenticazione dell'app predefinita o come getAuth(app) per accedere al servizio di autenticazione associato a un'app specifica.

Firma:

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

Parametri

Ritorna:

Aut

Esempio 1

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

Esempio 2

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

AuthFactorType

Identifica un secondo tipo di fattore.

Firma:

export type AuthFactorType = 'phone';

AuthProviderConfig

Il tipo di configurazione del provider di autenticazione. BaseAuth.createProviderConfig() .

Firma:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreaMultiFactorInfoRequest

Tipo che rappresenta le proprietà di un secondo fattore registrato dall'utente per una CreateRequest .

Firma:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

Crea richiesta tenant

Interfaccia che rappresenta le proprietà da impostare su un nuovo tenant.

Firma:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

Firma:

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 uno stato di configurazione a più fattori.

Firma:

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

PasswordPolicyEnforcementState

Lo stato di applicazione di una policy password.

Firma:

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

RecaptchaAzione

Le azioni da intraprendere per le richieste protette da reCAPTCHA. - 'BLOCCO': la richiesta protetta da reCAPTCHA verrà bloccata.

Firma:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Il tipo di piattaforma della chiave.

Firma:

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

RecaptchaProviderEnforcementState

Stato di applicazione della protezione reCAPTCHA. - 'OFF': non applicato. - "AUDIT": crea una valutazione ma non applica il risultato. - 'ENFORCE': crea una valutazione e applica il risultato.

Firma:

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

SmsRegionConfig

L'interfaccia di richiesta per l'aggiornamento di una configurazione della regione SMS. Configura le regioni in cui gli utenti possono inviare SMS di verifica. Questo si basa sul codice chiamante del numero di telefono di destinazione.

Firma:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Firma:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Tipo che rappresenta le proprietà di un secondo fattore registrato dall'utente per una UpdateRequest .

Firma:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identificatore utente

Identifica un utente da cercare.

Firma:

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