firebase-admin.auth package

Firebase-Authentifizierung.

Funktionen

Klassen

Schnittstellen

Geben Sie Aliase ein

getAuth()

Ruft den Authentifizierungsdienst für die Standard-App oder eine bestimmte App ab.

getAuth() kann ohne Argumente aufgerufen werden, um auf den Auth- Dienst der Standard-App zuzugreifen, oder als getAuth(app) um auf den Auth- Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

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

Parameter

Kehrt zurück:

Auth

Beispiel 1

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

Beispiel 2

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

AuthFactorType

Identifiziert einen zweiten Faktortyp.

Unterschrift:

export type AuthFactorType = 'phone';

AuthProviderConfig

Der Konfigurationstyp des Authentifizierungsanbieters. BaseAuth.createProviderConfig() .

Unterschrift:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

Typ, der die Eigenschaften eines vom Benutzer registrierten zweiten Faktors für eine CreateRequest darstellt .

Unterschrift:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

Schnittstelle, die die Eigenschaften darstellt, die für einen neuen Mandanten festgelegt werden sollen.

Unterschrift:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

Unterschrift:

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

MultiFactorConfigState

Identifiziert einen Multifaktor-Konfigurationsstatus.

Unterschrift:

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

PasswordPolicyEnforcementState

Der Durchsetzungsstatus einer Passwortrichtlinie.

Unterschrift:

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

RecaptchaAction

Die für reCAPTCHA-geschützte Anfragen zu ergreifenden Aktionen. - „BLOCK“: Die reCAPTCHA-geschützte Anfrage wird blockiert.

Unterschrift:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Der Plattformtyp des Schlüssels.

Unterschrift:

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

RecaptchaProviderEnforcementState

Durchsetzungsstatus des reCAPTCHA-Schutzes. - „AUS“: Nicht erzwungen. - „AUDIT“: Bewertung erstellen, aber das Ergebnis nicht erzwingen. - „ENFORCE“: Bewertung erstellen und das Ergebnis erzwingen.

Unterschrift:

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

SMSRegionConfig

Die Anforderungsschnittstelle zum Aktualisieren einer SMS-Regionskonfiguration. Konfiguriert die Regionen, in denen Benutzer Bestätigungs-SMS senden dürfen. Dies basiert auf der Rufvorwahl der Zielrufnummer.

Unterschrift:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Unterschrift:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Typ, der die Eigenschaften eines vom Benutzer registrierten zweiten Faktors für eine UpdateRequest darstellt .

Unterschrift:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Benutzeridentifikator

Identifiziert einen Benutzer, der gesucht werden soll.

Unterschrift:

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