auth package

Firebase Authentication

Funktionen

Funktion Beschreibung
function(App, ...)
getAuth(app) Gibt die Auth-Instanz zurück, die der bereitgestellten FirebaseApp zugeordnet ist. Wenn keine Instanz vorhanden ist, wird eine Auth-Instanz mit plattformspezifischen Standardabhängigkeiten initialisiert.
initializeAuth(app, deps) Initialisiert eine Auth-Instanz mit detaillierter Kontrolle über Abhängigkeiten.
function(Speicher; ...)
getReactNativePersistence(storage) Gibt ein Persistenzobjekt zurück, das aus react-native oder @react-native-community/async-storage importierte AsyncStorage umschließt und im Feld für die Persistenzabhängigkeit in initializeAuth() verwendet werden kann.
function(auth, ...)
applyActionCode(auth, oobCode) Es wird ein Bestätigungscode angewendet, der per E-Mail oder über einen anderen Out-of-Band-Mechanismus an den Nutzer gesendet wurde.
beforeAuthStateChanged(auth, callback, onAbort) Fügt einen blockierenden Callback hinzu, der ausgeführt wird, bevor durch eine Änderung des Authentifizierungsstatus ein neuer Nutzer festgelegt wird.
checkActionCode(auth, oobCode) Überprüft einen Bestätigungscode, der per E-Mail oder über einen anderen Out-of-Band-Mechanismus an den Nutzer gesendet wurde.
confirmPasswordReset(auth, oobCode, newPassword) Schließt das Zurücksetzen des Passworts ab und erhält einen Bestätigungscode und ein neues Passwort.
connectAuthEmulator(auth, url, options) Ändert die Auth-Instanz so, dass sie mit dem Firebase Auth Emulator anstelle von Firebase Auth-Produktionsdiensten kommuniziert.
createUserWithEmailAndPassword(auth, email, password) Erstellt ein neues Nutzerkonto, das mit der angegebenen E-Mail-Adresse und dem angegebenen Passwort verknüpft ist.
fetchSignInMethodsForEmail(auth, email) Ruft die Liste möglicher Anmeldemethoden für die angegebene E-Mail-Adresse ab. Diese Methode gibt eine leere Liste zurück, wenn der [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist, unabhängig von der Anzahl der für die jeweilige E-Mail verfügbaren Authentifizierungsmethoden.
getMultiFactorResolver(auth, error) Stellt einen MultiFactorResolver bereit, der sich für den Abschluss eines Multi-Faktor-Ablaufs eignet.
getRedirectResult(auth, resolver) Gibt UserCredential aus dem weiterleitungsbasierten Anmeldevorgang zurück.
initializeRecaptchaConfig(auth) Lädt die reCAPTCHA-Konfiguration in die Instanz Auth.
isSignInWithEmailLink(auth, emailLink) Überprüft, ob ein eingehender Link eine Anmeldung mit einem E-Mail-Link ist, der für signInWithEmailLink() geeignet ist.
onAuthStateChanged(auth, nextOrObserver, error, completed) Fügt einen Beobachter für Änderungen am Anmeldestatus des Nutzers hinzu.
onIdTokenChanged(auth, nextOrObserver, error, completed) Fügt einen Beobachter für Änderungen am ID-Token des angemeldeten Nutzers hinzu.
revokeAccessToken(auth, token) Hebt das angegebene Zugriffstoken auf. Unterstützt derzeit nur Apple OAuth-Zugriffstokens.
sendPasswordResetEmail(auth, email, actionCodeSettings) Sendet eine E-Mail zum Zurücksetzen des Passworts an die angegebene E-Mail-Adresse. Bei dieser Methode wird kein Fehler ausgegeben, wenn kein Nutzerkonto mit der angegebenen E-Mail-Adresse vorhanden ist und der [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist.
sendSignInLinkToEmail(auth, email, actionCodeSettings) Sendet dem Nutzer mit der angegebenen E-Mail-Adresse einen Anmeldelink.
setPersistence(auth, persistence) Ändert die Art der Persistenz auf der Auth-Instanz für die aktuell gespeicherte Auth-Sitzung und wendet diese Art der Persistenz auf zukünftige Anmeldeanfragen an, einschließlich der Anmeldung mit Weiterleitungsanfragen.
signInAnonymously(auth) Meldet sich asynchron als anonymer Nutzer an.
signInWithCredential(auth, credential) Meldet sich asynchron mit den angegebenen Anmeldedaten an.
signInWithCustomToken(auth, customToken) Meldet sich asynchron mit einem benutzerdefinierten Token an.
signInWithEmailAndPassword(auth, email, password) Meldet sich asynchron mit einer E-Mail-Adresse und einem Passwort an.
signInWithEmailLink(auth, email, emailLink) Anmeldung über einen E-Mail- und Anmelde-E-Mail-Link asynchron
signInWithPhoneNumber(auth, phoneNumber, appVerifier) Meldet sich asynchron über eine Telefonnummer an.
signInWithPopup(auth, provider, resolver) Authentifizierung eines Firebase-Clients mithilfe eines Pop-up-basierten OAuth-Authentifizierungsvorgangs.
signInWithRedirect(auth, provider, resolver) Authentifizierung eines Firebase-Clients mithilfe einer ganzseitigen Weiterleitung
signOut(auth) Der aktuelle Nutzer wird abgemeldet.
updateCurrentUser(auth, user) Legt den angegebenen Nutzer in der Auth-Instanz asynchron als Auth.currentUser fest.
useDeviceLanguage(auth) Legt die aktuelle Sprache auf die Standardeinstellung für Gerät/Browser fest.
validatePassword(auth, password) Validiert das Passwort anhand der Passwortrichtlinie, die für das Projekt oder den Mandanten konfiguriert wurde.
verifyPasswordResetCode(auth, code) Prüft einen Code zum Zurücksetzen des Passworts, der per E-Mail oder über einen anderen Out-of-Band-Mechanismus an den Nutzer gesendet wurde.
function(link; ...)
parseActionCodeURL(link) Analysiert den String des E-Mail-Aktionslinks und gibt eine ActionCodeURL zurück, wenn der Link gültig ist. Andernfalls wird null zurückgegeben.
function(Nutzer; ...)
deleteUser(user) Der Nutzer wird gelöscht und abgemeldet.
getIdToken(user, forceRefresh) Gibt ein JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird.
getIdTokenResult(user, forceRefresh) Gibt ein deserialisiertes JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird.
linkWithCredential(user, credential) Verknüpft das Nutzerkonto mit den angegebenen Anmeldedaten.
linkWithPhoneNumber(user, phoneNumber, appVerifier) Verknüpft das Nutzerkonto mit der angegebenen Telefonnummer.
linkWithPopup(user, provider, resolver) Verknüpft den authentifizierten Anbieter über einen Pop-up-basierten OAuth-Vorgang mit dem Nutzerkonto.
linkWithRedirect(user, provider, resolver) Verknüpft OAuthProvider über eine ganzseitige Weiterleitung mit dem Nutzerkonto.
multiFactor(user) Der MultiFactorUser für den Nutzer.
reauthenticateWithCredential(user, credential) Authentifizierung eines Nutzers mit neuen Anmeldedaten.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) Der Nutzer wird mit neuen Anmeldedaten für das Smartphone neu authentifiziert.
reauthenticateWithPopup(user, provider, resolver) Authentifizierung des aktuellen Nutzers mithilfe eines Pop-up-basierten OAuth-Vorgangs mit dem angegebenen OAuthProvider neu.
reauthenticateWithRedirect(user, provider, resolver) Authentifizierung des aktuellen Nutzers mit dem angegebenen OAuthProvider über eine ganzseitige Weiterleitung.
reload(Nutzer) Die Daten des Nutzerkontos werden aktualisiert, wenn Sie angemeldet sind.
sendEmailVerification(user, actionCodeSettings) Es wird eine Bestätigungs-E-Mail an einen Nutzer gesendet.
unlink(Nutzer, Anbieter-ID) Hebt die Verknüpfung eines Anbieters mit einem Nutzerkonto auf.
updateEmail(user, newEmail) Aktualisiert die E-Mail-Adresse des Nutzers.
updatePassword(user, newPassword) Aktualisiert das Passwort des Nutzers.
updatePhoneNumber(user, credential) Aktualisiert die Telefonnummer des Nutzers.
updateProfile(user, { displayName, photoURL: photoUrl }) Aktualisiert die Profildaten eines Nutzers.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) Bestätigungs-E-Mail an eine neue E-Mail-Adresse senden
function(userCredential, ...)
getAdditionalUserInfo(userCredential) Extrahiert anbieterspezifische AdditionalUserInfo für die angegebenen Anmeldedaten.

Kurse

Klasse Beschreibung
ActionCodeURL Eine Dienstprogrammklasse zum Parsen von URLs für E-Mail-Aktionen wie Passwortzurücksetzung, E-Mail-Bestätigung, Anmeldung über E-Mail-Links usw.
AuthCredential Schnittstelle, die die von einem AuthProvider zurückgegebenen Anmeldedaten darstellt.
EmailAuthCredential Schnittstelle, die die von EmailAuthProvider für ProviderId.PASSWORD zurückgegebenen Anmeldedaten darstellt
EmailAuthProvider Anbieter zum Generieren von EmailAuthCredential
FacebookAuthProvider Anbieter zum Generieren von OAuthCredential für ProviderId.FACEBOOK.
GithubAuthProvider Anbieter zum Generieren von OAuthCredential für ProviderId.GITHUB.
GoogleAuthProvider Anbieter zum Generieren eines OAuthCredential für ProviderId.GOOGLE.
OAuthCredential Stellt die OAuth-Anmeldedaten dar, die von einem OAuthProvider zurückgegeben werden.
OAuthProvider Anbieter zum Generieren von generischem OAuthCredential
PhoneAuthCredential Stellt die Anmeldedaten dar, die von PhoneAuthProvider zurückgegeben werden.
PhoneAuthProvider Anbieter zum Generieren von PhoneAuthCredential
PhoneMultiFactorGenerator Anbieter zum Generieren einer PhoneMultiFactorAssertion
RecaptchaVerifier Eine auf reCAPTCHA basierende App-Überprüfung
SAMLAuthProvider Ein AuthProvider für SAML.
TotpMultiFactorGenerator Anbieter zum Generieren einer TotpMultiFactorAssertion
TotpSecret Anbieter zum Generieren einer TotpMultiFactorAssertion.Speichert den gemeinsamen geheimen Schlüssel und andere Parameter, um zeitbasierte OTPs zu generieren. Implementiert Methoden zum Abrufen des gemeinsamen geheimen Schlüssels und zum Generieren einer QR-Code-URL.
TwitterAuthProvider Anbieter zum Generieren von OAuthCredential für ProviderId.TWITTER

Interfaces

Schnittstelle Beschreibung
ActionCodeInfo Eine Antwort von checkActionCode()
ActionCodeSettings Eine Schnittstelle, über die die erforderliche Fortsetzungs-/Status-URL mit optionalen Android- und iOS-Bundle-IDs definiert wird.
AdditionalUserInfo Eine Struktur, die zusätzliche Nutzerinformationen von einem Anbieter föderierter Identität enthält.
ApplicationVerifier Ein Prüfer zur Domainbestätigung und zum Schutz vor Missbrauch.
Authentifizierung Schnittstelle, die den Firebase Auth-Dienst darstellt.
AuthError Schnittstelle für einen Auth-Fehler.
AuthErrorMap Eine Zuordnung von Fehlercodes zu Fehlermeldungen.
AuthProvider Schnittstelle, die einen Authentifizierungsanbieter darstellt und zum Erstellen von AuthCredential verwendet wird.
AuthSettings Schnittstelle, die die Einstellungen einer Auth-Instanz darstellt.
Konfiguration Schnittstelle, die die Auth-Konfiguration darstellt.
ConfirmationResult Das Ergebnis einer Anmeldung, eines Links oder einer erneuten Authentifizierung eines Anrufs mit einer Telefonnummer.
Abhängigkeiten Die Abhängigkeiten, die zum Initialisieren einer Auth-Instanz verwendet werden können.
EmulatorConfig Konfiguration des Firebase Authentication Emulators.
IdTokenResult Schnittstelle, die das ID-Token-Ergebnis darstellt, das von User.getIdTokenResult() abgerufen wurde.
MultiFactorAssertion Die Basisklasse zur Geltendmachung von Eigentumsrechten eines zweiten Faktors.
MultiFactorError Fehlermeldung, die ausgegeben wird, wenn der Nutzer für eine erfolgreiche Anmeldung einen zweiten Faktor angeben muss.
MultiFactorInfo Struktur, die die Informationen zu einer Zweitfaktorentität enthält.
MultiFactorResolver Mit dieser Klasse wird die Wiederherstellung nach dem MultiFactorError erleichtert, wenn ein Nutzer bei der Anmeldung einen zweiten Faktor angeben muss.
MultiFactorSession Eine Benutzeroberfläche, in der das Multi-Faktor-Sitzungsobjekt definiert wird, das zum Registrieren eines zweiten Faktors für einen Nutzer oder zum Anmelden eines registrierten Nutzers mit einem zweiten Faktor verwendet wird.
MultiFactorUser Eine Schnittstelle, die die Multi-Faktor-bezogenen Eigenschaften und Vorgänge für einen Nutzer definiert.
OAuthCredentialOptions Definiert die Optionen zum Initialisieren von OAuthCredential.
ParsedToken Schnittstelle, die ein geparstes ID-Token darstellt.
PasswordPolicy Struktur, die Richtlinienanforderungen für Passwörter festlegt.
PasswordValidationStatus Eine Struktur, die angibt, welche Anforderungen der Passwortrichtlinien erfüllt oder verletzt wurden und welche Anforderungen erfüllt sind.
Persistenz Eine Schnittstelle, die die möglichen Typen von Persistenzmechanismen abdeckt.
PhoneMultiFactorAssertion Die Klasse zur Geltendmachung der Inhaberschaft eines Smartphones im zweiten Faktor. Bereitgestellt von PhoneMultiFactorGenerator.assertion().
PhoneMultiFactorEnrollInfoOptions Optionen für die Registrierung eines zweiten Faktors.
PhoneMultiFactorInfo Die Unterklasse der MultiFactorInfo-Schnittstelle für zweite Faktoren von Telefonnummern. Der factorId dieses zweiten Faktors ist FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions Optionen für die Anmeldung mit einem zweiten Faktor.
PhoneSingleFactorInfoOptions Optionen für die Einzel-Faktor-Anmeldung.
PopupRedirectResolver Ein Resolver für die Verarbeitung von DOM-spezifischen Vorgängen wie signInWithPopup() oder signInWithRedirect().
ReactNativeAsyncStorage Schnittstelle für ein bereitgestelltes AsyncStorage.
RecaptchaParameters Schnittstelle, die reCAPTCHA-Parameter darstellt.Eine Liste der zulässigen Parameter finden Sie in der [reCAPTCHA-Dokumentation](https://developers.google.com/recaptcha/docs/display#render_param). Alle Parameter mit Ausnahme von sitekey werden akzeptiert: Firebase Auth stellt für jedes Projekt ein reCAPTCHA bereit und konfiguriert den Websiteschlüssel beim Rendern.Setze für ein unsichtbares reCAPTCHA den Schlüssel size auf invisible.
TotpMultiFactorAssertion Die Klasse zur Geltendmachung der Eigentumsrechte eines zweiten TOTP-Faktors. Bereitgestellt von TotpMultiFactorGenerator.assertionForEnrollment() und TotpMultiFactorGenerator.assertionForSignIn().
TotpMultiFactorInfo Die Unterklasse der MultiFactorInfo-Schnittstelle für TOTP-Zweite Faktoren. Die factorId dieses zweiten Faktors ist FactorId.TOTP.
Nutzer Ein Nutzerkonto.
UserCredential Struktur mit einem Nutzer, dem OperationType und der Anbieter-ID.
UserInfo Nutzerprofilinformationen, die nur für die Apps des Firebase-Projekts sichtbar sind.
UserMetadata Benutzeroberfläche, die die Metadaten eines Nutzers darstellt.

Variablen

Variable Beschreibung
ActionCodeOperation Eine Aufzählung der möglichen E-Mail-Aktionstypen.
AuthErrorCodes Eine Übersicht potenzieller Auth-Fehlercodes für einen einfacheren Vergleich mit Fehlern, die vom SDK ausgegeben werden.
browserLocalPersistence Eine Implementierung von Persistence vom Typ LOCAL unter Verwendung von localStorage für den zugrunde liegenden Speicher.
browserPopupRedirectResolver Eine für browserbasierte Anwendungen geeignete Implementierung von PopupRedirectResolver.
browserSessionPersistence Eine Implementierung von Persistence von SESSION unter Verwendung von sessionStorage für den zugrunde liegenden Speicher.
cordovaPopupRedirectResolver Eine Implementierung von PopupRedirectResolver, die für Cordova-basierte Anwendungen geeignet ist.
debugErrorMap Eine ausführliche Fehlerkarte mit detaillierten Beschreibungen für die meisten Fehlercodes.Siehe Diskussion unter AuthErrorMap
FactorId Eine Aufzählung von Faktoren, die für die Multi-Faktor-Authentifizierung verwendet werden können.
indexedDBLocalPersistence Eine Implementierung von Persistence vom Typ LOCAL unter Verwendung von indexedDB für den zugrunde liegenden Speicher.
inMemoryPersistence Eine Implementierung von Persistence vom Typ 'NONE'.
OperationType Aufzählung der unterstützten Vorgangstypen.
prodErrorMap Eine Karte mit minimalen Fehlern ohne alle ausführlichen Fehlermeldungen.Siehe Diskussion unter AuthErrorMap
ProviderId Aufzählung der unterstützten Anbieter.
SignInMethod Aufzählung der unterstützten Anmeldemethoden.

Typaliasse

Typalias Beschreibung
CustomParameters Zuordnung von benutzerdefinierten OAuth-Parametern.
NextOrObserver Typdefinition für einen Ereignis-Callback.
PhoneInfoOptions Die Informationen, die erforderlich sind, um die Inhaberschaft einer Telefonnummer zu bestätigen.
UserProfile In AdditionalUserInfo verwendetes Nutzerprofil

Funktion(App; ...)

getAuth(app)

Gibt die Auth-Instanz zurück, die der bereitgestellten FirebaseApp zugeordnet ist. Wenn keine Instanz vorhanden ist, wird eine Auth-Instanz mit plattformspezifischen Standardabhängigkeiten initialisiert.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App FirebaseApp Die Firebase App

Gibt zurück:

Authentifizierung

initializeAuth(app, deps)

Initialisiert eine Auth-Instanz mit detaillierter Kontrolle über Abhängigkeiten.

Diese Funktion bietet mehr Kontrolle über die Auth-Instanz als getAuth(). getAuth verwendet plattformspezifische Standardeinstellungen, um die Abhängigkeiten bereitzustellen. Im Allgemeinen ist getAuth die einfachste Methode, Auth zu initialisieren. Sie funktioniert in den meisten Anwendungsfällen. Verwenden Sie initializeAuth, wenn Sie steuern möchten, welche Persistenzschicht verwendet wird, oder um die Bundle-Größe zu minimieren, wenn Sie weder signInWithPopup noch signInWithRedirect verwenden.

Wenn in Ihrer App beispielsweise nur anonyme Konten verwendet werden und Sie nur Konten für die aktuelle Sitzung speichern möchten, initialisieren Sie Auth mit:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

Unterschrift:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

Parameter

Parameter Typ Beschreibung
App FirebaseApp
Abfahrten Abhängigkeiten

Gibt zurück:

Authentifizierung

Funktion(Speicher; ...)

getReactNativePersistence(storage)

Gibt ein Persistenzobjekt zurück, das aus react-native oder @react-native-community/async-storage importierte AsyncStorage umschließt und im Feld für die Persistenzabhängigkeit in initializeAuth() verwendet werden kann.

Unterschrift:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

Parameter

Parameter Typ Beschreibung
storage ReactNativeAsyncStorage

Gibt zurück:

Persistenz

function(auth; ...)

applyActionCode(auth, oobCode)

Es wird ein Bestätigungscode angewendet, der per E-Mail oder über einen anderen Out-of-Band-Mechanismus an den Nutzer gesendet wurde.

Unterschrift:

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
oobCode String Ein Bestätigungscode, der an den Nutzer gesendet wurde.

Gibt zurück:

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

Fügt einen blockierenden Callback hinzu, der ausgeführt wird, bevor durch eine Änderung des Authentifizierungsstatus ein neuer Nutzer festgelegt wird.

Unterschrift:

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
callback (user: User | null) => void | Promise<void> , der ausgelöst wird, bevor ein neuer Nutzerwert festgelegt wird. Wenn dies ausgelöst wird, kann der Nutzer nicht festgelegt werden.
onAbort () => void Callback wird ausgelöst, wenn später ein beforeAuthStateChanged()-Callback ausgelöst wird, sodass du mögliche Nebeneffekte rückgängig machen kannst.

Gibt zurück:

Abbestellen

checkActionCode(auth, oobCode)

Überprüft einen Bestätigungscode, der per E-Mail oder über einen anderen Out-of-Band-Mechanismus an den Nutzer gesendet wurde.

Unterschrift:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
oobCode String Ein Bestätigungscode, der an den Nutzer gesendet wurde.

Gibt zurück:

Promise<ActionCodeInfo>

Metadaten über den Code.

confirmPasswordReset(auth, oobCode, newPassword)

Schließt das Zurücksetzen des Passworts ab und erhält einen Bestätigungscode und ein neues Passwort.

Unterschrift:

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
oobCode String Einen Bestätigungscode, der an den Nutzer gesendet wurde.
newPassword String Das neue Passwort.

Gibt zurück:

Promise<void>

connectAuthEmulator(auth, url, options)

Ändert die Auth-Instanz so, dass sie mit dem Firebase Auth Emulator anstelle von Firebase Auth-Produktionsdiensten kommuniziert.

Dies muss synchron nach dem ersten Aufruf von initializeAuth() aufgerufen werden. Nicht mit Produktionsanmeldedaten verwenden, da der Emulator-Traffic nicht verschlüsselt ist.

Unterschrift:

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
url String Die URL, unter der der Emulator ausgeführt wird (z. B. http://localhost:9099).
Optionen { disableWarnings: boolean; } Optional. Der Standardwert für options.disableWarnings ist false. Legen Sie dafür true fest, um das Warnbanner zu deaktivieren, das an das DOM angehängt ist.

Gibt zurück:

void

Beispiel

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(auth, email, password)

Erstellt ein neues Nutzerkonto, das mit der angegebenen E-Mail-Adresse und dem angegebenen Passwort verknüpft ist.

Nach erfolgreicher Erstellung des Nutzerkontos wird dieser Nutzer auch in Ihrer App angemeldet.

Das Nutzerkonto kann nicht erstellt werden, wenn das Konto bereits existiert oder das Passwort ungültig ist.

Diese Methode wird bei Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden, nicht unterstützt.

Unterschrift:

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
E-Mail String Die E-Mail-Adresse des Nutzers.
Passwort String Das vom Nutzer gewählte Passwort.

Gibt zurück:

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

Ruft die Liste möglicher Anmeldemethoden für die angegebene E-Mail-Adresse ab. Diese Methode gibt eine leere Liste zurück, wenn der [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist, unabhängig von der Anzahl der für die jeweilige E-Mail verfügbaren Authentifizierungsmethoden.

Dies ist nützlich, um Anmeldemethoden für denselben Anbieter zu unterscheiden, z. B. EmailAuthProvider, die zwei Anmeldemethoden hat: SignInMethod.EMAIL_PASSWORD und SignInMethod.EMAIL_LINK.

Unterschrift:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
E-Mail String Die E-Mail-Adresse des Nutzers.Eingestellt. Die Migration dieser Methode wird als Best Practice für die Sicherheit empfohlen. Weitere Informationen finden Sie in der Identity Platform-Dokumentation zum [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

Gibt zurück:

Versprechen<string[]>

getMultiFactorResolver(auth, error)

Stellt einen MultiFactorResolver bereit, der sich für den Abschluss eines Multi-Faktor-Ablaufs eignet.

Unterschrift:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
error MultiFactorError MultiFactorError, der bei einer Anmeldung oder erneuten Authentifizierung ausgelöst wurde.

Gibt zurück:

MultiFactorResolver

getRedirectResult(auth, resolver)

Gibt UserCredential aus dem weiterleitungsbasierten Anmeldevorgang zurück.

Bei erfolgreicher Anmeldung wird der angemeldete Nutzer zurückgegeben. Wenn die Anmeldung nicht erfolgreich war, wird ein Fehler ausgegeben. Falls kein Weiterleitungsvorgang aufgerufen wurde, wird null zurückgegeben.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Promise<UserCredential | null>

Beispiel

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

initializeRecaptchaConfig(auth)

Lädt die reCAPTCHA-Konfiguration in die Instanz Auth.

Dadurch wird die reCAPTCHA-Konfiguration geladen, die angibt, ob der reCAPTCHA-Bestätigungsvorgang für jeden Authentifizierungsanbieter ausgelöst werden soll, in die aktuelle Authentifizierungssitzung.

Wird „initialRecaptchaConfig()“ nicht aufgerufen, startet der Authentifizierungsablauf immer ohne reCAPTCHA-Überprüfung. Wenn der Anbieter so konfiguriert ist, dass eine reCAPTCHA-Überprüfung erforderlich ist, lädt das SDK transparent die reCAPTCHA-Konfiguration und startet die Authentifizierungsabläufe neu.

Durch Aufrufen dieser optionalen Methode reduzieren Sie daher die Latenz bei zukünftigen Authentifizierungsabläufen. Durch ein frühzeitiges Laden der reCAPTCHA-Konfiguration wird auch das von reCAPTCHA erfasste Signal verbessert.

Diese Methode funktioniert nicht in einer Node.js-Umgebung.

Unterschrift:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.

Gibt zurück:

Promise<void>

Beispiel

initializeRecaptchaConfig(auth);

Überprüft, ob ein eingehender Link eine Anmeldung mit einem E-Mail-Link ist, der für signInWithEmailLink() geeignet ist.

Unterschrift:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
emailLink String Der Link, der an die E-Mail-Adresse des Nutzers gesendet wurde.

Gibt zurück:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

Fügt einen Beobachter für Änderungen am Anmeldestatus des Nutzers hinzu.

Informationen zum Beibehalten des alten Verhaltens finden Sie unter onIdTokenChanged().

Unterschrift:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
nextOrObserver NextOrObserver<Nutzer> -Rückruf wird bei einer Änderung ausgelöst.
error ErrorFn Veraltet. Dieser Callback wird nie ausgelöst. Fehler beim An- und Abmelden können in Promise enthalten sein, die von Anmelde-/Abmeldefunktionen zurückgegeben werden.
abgeschlossen CompleteFn Veraltet. Dieser Callback wird nie ausgelöst.

Gibt zurück:

Abbestellen

onIdTokenChanged(auth, nextOrObserver, error, completed)

Fügt einen Beobachter für Änderungen am ID-Token des angemeldeten Nutzers hinzu.

Dazu gehören die Anmeldung und Abmeldung sowie die Aktualisierung von Tokens. Sie wird nicht automatisch nach Ablauf des ID-Tokens ausgelöst. Verwenden Sie User.getIdToken(), um das ID-Token zu aktualisieren.

Unterschrift:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
nextOrObserver NextOrObserver<Nutzer> -Rückruf wird bei einer Änderung ausgelöst.
error ErrorFn Veraltet. Dieser Callback wird nie ausgelöst. Fehler beim An- und Abmelden können in Promise enthalten sein, die von Anmelde-/Abmeldefunktionen zurückgegeben werden.
abgeschlossen CompleteFn Veraltet. Dieser Callback wird nie ausgelöst.

Gibt zurück:

Abbestellen

revokeAccessToken(auth, token)

Hebt das angegebene Zugriffstoken auf. Unterstützt derzeit nur Apple OAuth-Zugriffstokens.

Unterschrift:

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
Token String Das OAuth-Zugriffstoken von Apple

Gibt zurück:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Sendet eine E-Mail zum Zurücksetzen des Passworts an die angegebene E-Mail-Adresse. Bei dieser Methode wird kein Fehler ausgegeben, wenn kein Nutzerkonto mit der angegebenen E-Mail-Adresse vorhanden ist und der [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist.

Um das Zurücksetzen des Passworts abzuschließen, rufen Sie confirmPasswordReset() und das neue, vom Nutzer festgelegte Passwort auf. Verwenden Sie dabei den Code aus der E-Mail, die an den Nutzer gesendet wurde.

Unterschrift:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
E-Mail String Die E-Mail-Adresse des Nutzers.
actionCodeSettings ActionCodeSettings ActionCodeSettings

Gibt zurück:

Promise<void>

Beispiel

const 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
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

Sendet dem Nutzer mit der angegebenen E-Mail-Adresse einen Anmeldelink.

Im Gegensatz zu anderen Out-of-Band-E-Mail-Aktionen (Zurücksetzen des Passworts und E-Mail-Bestätigungen) muss die Anmeldung immer in der App durchgeführt werden. Das liegt daran, dass der Nutzer am Ende des Vorgangs angemeldet sein muss und sein Authentifizierungsstatus in der App beibehalten wird.

Um die Anmeldung mit dem E-Mail-Link abzuschließen, rufen Sie signInWithEmailLink() mit der E-Mail-Adresse und dem E-Mail-Link aus der E-Mail auf, die an den Nutzer gesendet wurde.

Unterschrift:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung
E-Mail String Die E-Mail-Adresse des Nutzers.
actionCodeSettings ActionCodeSettings ActionCodeSettings

Gibt zurück:

Promise<void>

Beispiel

const 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
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

setPersistence(auth, persistence)

Ändert die Art der Persistenz auf der Auth-Instanz für die aktuell gespeicherte Auth-Sitzung und wendet diese Art der Persistenz auf zukünftige Anmeldeanfragen an, einschließlich der Anmeldung mit Weiterleitungsanfragen.

So kann ein angemeldeter Nutzer einfach angeben, ob seine Sitzung gespeichert werden soll oder nicht. Außerdem ist es so einfacher, den Status Auth für Anwendungen, die von anderen Nutzern gemeinsam genutzt werden oder sensible Daten enthalten, nie dauerhaft beizubehalten.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
Persistenz Persistenz Die zu verwendende Persistenz.

Gibt zurück:

Promise<void>

Ein Promise, der aufgelöst wird, sobald die Persistenzänderung abgeschlossen ist

Beispiel

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Meldet sich asynchron als anonymer Nutzer an.

Wenn bereits ein anonymer Nutzer angemeldet ist, wird dieser Nutzer zurückgegeben. Andernfalls wird eine neue anonyme Nutzeridentität erstellt und zurückgegeben.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.

Gibt zurück:

Promise<UserCredential>

signInWithCredential(auth, credential)

Meldet sich asynchron mit den angegebenen Anmeldedaten an.

Ein AuthProvider kann zum Generieren der Anmeldedaten verwendet werden.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
anmelde daten AuthCredential Die Anmeldedaten für die Authentifizierung.

Gibt zurück:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

Meldet sich asynchron mit einem benutzerdefinierten Token an.

Benutzerdefinierte Tokens werden verwendet, um Firebase Auth in vorhandene Authentifizierungssysteme zu integrieren, und müssen von einem Authentifizierungs-Backend mithilfe der Methode createCustomToken im Admin SDK generiert werden .

Es wird ein Fehler ausgegeben, wenn das Token ungültig, abgelaufen oder vom Firebase Auth-Dienst nicht akzeptiert wird.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
customToken String Das benutzerdefinierte Token für die Anmeldung.

Gibt zurück:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

Meldet sich asynchron mit einer E-Mail-Adresse und einem Passwort an.

Es wird ein Fehler ausgegeben, wenn E-Mail-Adresse und Passwort nicht übereinstimmen. Wenn der [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist, schlägt diese Methode bei einer ungültigen E-Mail-Adresse oder einem ungültigen Passwort mit „auth/invalid-credential“ fehl.

Diese Methode wird bei Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden, nicht unterstützt.

Unterschrift:

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
E-Mail String Die E-Mail-Adresse des Nutzers.
Passwort String Das Passwort des Nutzers.

Gibt zurück:

Promise<UserCredential>

Anmeldung über einen E-Mail- und Anmelde-E-Mail-Link asynchron

Wenn kein Link übergeben wird, wird der Link von der aktuellen URL abgeleitet.

Es wird ein Fehler ausgegeben, wenn die E-Mail-Adresse ungültig ist oder das OTP im E-Mail-Link abläuft.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
E-Mail String Die E-Mail-Adresse des Nutzers.
emailLink String Der Link, der an die E-Mail-Adresse des Nutzers gesendet wurde.

Gibt zurück:

Promise<UserCredential>

Beispiel

const 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
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

signInWithPhoneNumber(auth, phoneNumber, appVerifier)

Meldet sich asynchron über eine Telefonnummer an.

Mit dieser Methode wird ein Code per SMS an die angegebene Telefonnummer gesendet und ein ConfirmationResult zurückgegeben. Nachdem der Nutzer den an sein Smartphone gesendeten Code eingegeben hat, rufen Sie mit dem Code ConfirmationResult.confirm() auf, um den Nutzer anzumelden.

Zur Vermeidung von Missbrauch ist für diese Methode außerdem ein ApplicationVerifier erforderlich. Dieses SDK enthält eine reCAPTCHA-basierte Implementierung: RecaptchaVerifier. Diese Funktion kann auch auf anderen Plattformen ausgeführt werden, die den RecaptchaVerifier nicht unterstützen (z. B. React Native). Sie müssen jedoch eine ApplicationVerifier-Implementierung eines Drittanbieters verwenden.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
phoneNumber String Die Telefonnummer des Nutzers im E.164-Format (z.B. +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier

Gibt zurück:

Promise<ConfirmationResult>

Beispiel

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

signInWithPopup(auth, provider, resolver)

Authentifizierung eines Firebase-Clients mithilfe eines Pop-up-basierten OAuth-Authentifizierungsvorgangs.

Bei Erfolg wird der angemeldete Nutzer zusammen mit den Anmeldedaten des Anbieters zurückgegeben. Wenn die Anmeldung nicht erfolgreich war, wird ein Fehlerobjekt mit zusätzlichen Informationen zum Fehler zurückgegeben.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
provider AuthProvider Der zu authentifizierende Anbieter. Der Anbieter muss ein OAuthProvider sein. Nicht-OAuth-Anbieter wie EmailAuthProvider geben einen Fehler aus.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Promise<UserCredential>

Beispiel

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithRedirect(auth, provider, resolver)

Authentifizierung eines Firebase-Clients mithilfe einer ganzseitigen Weiterleitung

Informationen zum Umgang mit den Ergebnissen und Fehlern für diesen Vorgang finden Sie unter getRedirectResult(). Folgen Sie den Best Practices für die Verwendung von signInWithRedirect().

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
provider AuthProvider Der zu authentifizierende Anbieter. Der Anbieter muss ein OAuthProvider sein. Nicht-OAuth-Anbieter wie EmailAuthProvider geben einen Fehler aus.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Versprechen<never>

Beispiel

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

signOut(auth)

Der aktuelle Nutzer wird abgemeldet.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function signOut(auth: Auth): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.

Gibt zurück:

Promise<void>

updateCurrentUser(auth, user)

Legt den angegebenen Nutzer in der Auth-Instanz asynchron als Auth.currentUser fest.

Es wird eine neue Instanzkopie des bereitgestellten Nutzers erstellt und als currentUser festgelegt.

Dadurch werden die Listener onAuthStateChanged() und onIdTokenChanged() wie andere Anmeldemethoden ausgelöst.

Der Vorgang schlägt mit einem Fehler fehl, wenn der zu aktualisierende Nutzer zu einem anderen Firebase-Projekt gehört.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
Nutzer Nutzer | null Der neue Nutzer.

Gibt zurück:

Promise<void>

useDeviceLanguage(auth)

Legt die aktuelle Sprache auf die Standardeinstellung für Gerät/Browser fest.

Unterschrift:

export declare function useDeviceLanguage(auth: Auth): void;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.

Gibt zurück:

void

validatePassword(auth, password)

Validiert das Passwort anhand der Passwortrichtlinie, die für das Projekt oder den Mandanten konfiguriert wurde.

Wenn für die Instanz Auth keine Mandanten-ID festgelegt ist, verwendet diese Methode die für das Projekt konfigurierte Passwortrichtlinie. Andernfalls verwendet diese Methode die für den Mandanten konfigurierte Richtlinie. Wenn keine Passwortrichtlinie konfiguriert wurde, wird die für alle Projekte konfigurierte Standardrichtlinie verwendet.

Wenn ein Authentifizierungsvorgang fehlschlägt, weil ein eingereichtes Passwort nicht den Anforderungen der Passwortrichtlinie entspricht und diese Methode bereits aufgerufen wurde, wird beim nächsten Aufruf die neueste Richtlinie verwendet.

Unterschrift:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
Passwort String Das zu bestätigende Passwort.

Gibt zurück:

Promise<PasswordValidationStatus>

Beispiel

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

Prüft einen Code zum Zurücksetzen des Passworts, der per E-Mail oder über einen anderen Out-of-Band-Mechanismus an den Nutzer gesendet wurde.

Unterschrift:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

Parameter

Parameter Typ Beschreibung
Auth Authentifizierung Die Auth-Instanz.
Code String Ein Bestätigungscode, der an den Nutzer gesendet wurde.

Gibt zurück:

Versprechen<string>

die E-Mail-Adresse des Nutzers, falls gültig.

Funktion(Link; ...)

parseActionCodeURL(Link)

Analysiert den String des E-Mail-Aktionslinks und gibt eine ActionCodeURL zurück, wenn der Link gültig ist. Andernfalls wird null zurückgegeben.

Unterschrift:

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

Parameter

Parameter Typ Beschreibung
Link String

Gibt zurück:

ActionCodeURL | null

Funktion(Nutzer; ...)

deleteUser(user)

Der Nutzer wird gelöscht und abgemeldet.

Unterschrift:

export declare function deleteUser(user: User): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer

Gibt zurück:

Promise<void>

getIdToken(user, forceRefresh)

Gibt ein JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird.

Gibt das aktuelle Token zurück, wenn es nicht abgelaufen ist oder nicht innerhalb der nächsten fünf Minuten abläuft. Andernfalls wird das Token aktualisiert und ein neues zurückgegeben.

Unterschrift:

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
forceRefresh boolean Erzwingt die Aktualisierung unabhängig vom Ablauf des Tokens.

Gibt zurück:

Versprechen<string>

getIdTokenResult(user, forceRefresh)

Gibt ein deserialisiertes JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird.

Gibt das aktuelle Token zurück, wenn es nicht abgelaufen ist oder nicht innerhalb der nächsten fünf Minuten abläuft. Andernfalls wird das Token aktualisiert und ein neues zurückgegeben.

Unterschrift:

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
forceRefresh boolean Erzwingt die Aktualisierung unabhängig vom Ablauf des Tokens.

Gibt zurück:

Promise<IdTokenResult>

linkWithCredential(user, credential)

Verknüpft das Nutzerkonto mit den angegebenen Anmeldedaten.

Ein AuthProvider kann zum Generieren der Anmeldedaten verwendet werden.

Unterschrift:

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
anmelde daten AuthCredential Die Anmeldedaten für die Authentifizierung.

Gibt zurück:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

Verknüpft das Nutzerkonto mit der angegebenen Telefonnummer.

Diese Methode funktioniert nicht in einer Node.js-Umgebung.

Unterschrift:

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
phoneNumber String Die Telefonnummer des Nutzers im E.164-Format (z.B. +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier

Gibt zurück:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

Verknüpft den authentifizierten Anbieter über einen Pop-up-basierten OAuth-Vorgang mit dem Nutzerkonto.

Wenn die Verknüpfung erfolgreich ist, enthält das zurückgegebene Ergebnis den Nutzer und die Anmeldedaten des Anbieters.

Diese Methode funktioniert nicht in einer Node.js-Umgebung.

Unterschrift:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
provider AuthProvider Der zu authentifizierende Anbieter. Der Anbieter muss ein OAuthProvider sein. Nicht-OAuth-Anbieter wie EmailAuthProvider geben einen Fehler aus.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Promise<UserCredential>

Beispiel

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithRedirect(user, provider, resolver)

Verknüpft OAuthProvider über eine ganzseitige Weiterleitung mit dem Nutzerkonto.

Informationen zum Umgang mit den Ergebnissen und Fehlern für diesen Vorgang finden Sie unter getRedirectResult(). Folgen Sie den Best Practices für die Verwendung von linkWithRedirect().

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
provider AuthProvider Der zu authentifizierende Anbieter. Der Anbieter muss ein OAuthProvider sein. Nicht-OAuth-Anbieter wie EmailAuthProvider geben einen Fehler aus.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Versprechen<never>

Beispiel

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

multiFactor(user)

Der MultiFactorUser für den Nutzer.

Wird verwendet, um auf alle Multi-Faktor-Properties und -Vorgänge im Zusammenhang mit dem Nutzer zuzugreifen.

Unterschrift:

export declare function multiFactor(user: User): MultiFactorUser;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer

Gibt zurück:

MultiFactorUser

reauthenticateWithCredential(user, credential)

Authentifizierung eines Nutzers mit neuen Anmeldedaten.

Verwenden Sie diese Option vor Vorgängen wie updatePassword(), für die Tokens von kürzlich erfolgten Anmeldeversuchen erforderlich sind. Diese Methode kann zur Wiederherstellung nach einem CREDENTIAL_TOO_OLD_LOGIN_AGAIN- oder TOKEN_EXPIRED-Fehler verwendet werden.

Diese Methode wird bei keinem User unterstützt, der über Auth-Instanzen angemeldet ist, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
anmelde daten AuthCredential Die Anmeldedaten für die Authentifizierung.

Gibt zurück:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

Der Nutzer wird mit neuen Anmeldedaten für das Smartphone neu authentifiziert.

Verwenden Sie diese Option vor Vorgängen wie updatePassword(), für die Tokens von kürzlich erfolgten Anmeldeversuchen erforderlich sind.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder auf User, die über Auth-Instanzen angemeldet sind, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
phoneNumber String Die Telefonnummer des Nutzers im E.164-Format (z.B. +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier

Gibt zurück:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

Authentifizierung des aktuellen Nutzers mithilfe eines Pop-up-basierten OAuth-Vorgangs mit dem angegebenen OAuthProvider neu.

Wenn die erneute Authentifizierung erfolgreich ist, enthält das zurückgegebene Ergebnis den Nutzer und die Anmeldedaten des Anbieters.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder auf User, die über Auth-Instanzen angemeldet sind, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
provider AuthProvider Der zu authentifizierende Anbieter. Der Anbieter muss ein OAuthProvider sein. Nicht-OAuth-Anbieter wie EmailAuthProvider geben einen Fehler aus.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Promise<UserCredential>

Beispiel

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reauthenticateWithRedirect(user, provider, resolver)

Authentifizierung des aktuellen Nutzers mit dem angegebenen OAuthProvider über eine ganzseitige Weiterleitung.

Informationen zum Umgang mit den Ergebnissen und Fehlern für diesen Vorgang finden Sie unter getRedirectResult(). Folgen Sie den Best Practices für die Verwendung von reauthenticateWithRedirect().

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder mit Auth-Instanzen, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
provider AuthProvider Der zu authentifizierende Anbieter. Der Anbieter muss ein OAuthProvider sein. Nicht-OAuth-Anbieter wie EmailAuthProvider geben einen Fehler aus.
Resolver PopupRedirectResolver Eine Instanz von PopupRedirectResolver, optional, wenn bereits an initializeAuth() oder durch getAuth() bereitgestellt.

Gibt zurück:

Versprechen<never>

Beispiel

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

Aktualisierung(Nutzer)

Die Daten des Nutzerkontos werden aktualisiert, wenn Sie angemeldet sind.

Unterschrift:

export declare function reload(user: User): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer

Gibt zurück:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

Es wird eine Bestätigungs-E-Mail an einen Nutzer gesendet.

Die Überprüfung erfolgt durch Aufrufen von applyActionCode().

Unterschrift:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
actionCodeSettings ActionCodeSettings | null ActionCodeSettings

Gibt zurück:

Promise<void>

Beispiel

const 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
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

Hebt die Verknüpfung eines Anbieters mit einem Nutzerkonto auf.

Unterschrift:

export declare function unlink(user: User, providerId: string): Promise<User>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
providerId String Der Anbieter, dessen Verknüpfung aufgehoben werden soll.

Gibt zurück:

Promise<Nutzer>

updateEmail(user, newEmail)

Aktualisiert die E-Mail-Adresse des Nutzers.

Es wird eine E-Mail an die ursprüngliche E-Mail-Adresse (sofern festgelegt) gesendet, mit der die Änderung der E-Mail-Adresse widerrufen werden kann, um den Nutzer vor Kontodiebstahl zu schützen.

Diese Methode wird bei keinem User unterstützt, der über Auth-Instanzen angemeldet ist, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
newEmail String Die neue E-Mail-Adresse.Es wird der Fehler „auth/operation-not-allowed“ ausgegeben, wenn der [Schutz vor E-Mail-Enumeration](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist. Eingestellt: Verwenden Sie stattdessen verifyBeforeUpdateEmail().

Gibt zurück:

Promise<void>

updatePassword(user, newPassword)

Aktualisiert das Passwort des Nutzers.

Unterschrift:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
newPassword String Das neue Passwort.

Gibt zurück:

Promise<void>

updatePhoneNumber(user, credential)

Aktualisiert die Telefonnummer des Nutzers.

Diese Methode funktioniert nicht in einer Node.js-Umgebung oder auf User, die über Auth-Instanzen angemeldet sind, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
anmelde daten PhoneAuthCredential Ein Ausweisdokument zur Authentifizierung der neuen Telefonnummer.

Gibt zurück:

Promise<void>

Beispiel

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(user, { displayName, photoURL: photoUrl })

Aktualisiert die Profildaten eines Nutzers.

Unterschrift:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
{ displayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

Gibt zurück:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

Bestätigungs-E-Mail an eine neue E-Mail-Adresse senden

Die E-Mail-Adresse des Nutzers wird nach der Bestätigung auf die neue E-Mail-Adresse aktualisiert.

Wenn Sie einen benutzerdefinierten Handler für E-Mail-Aktionen haben, können Sie die Bestätigung mit applyActionCode() abschließen.

Unterschrift:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer Den Nutzer
newEmail String Die neue E-Mail-Adresse, die vor der Aktualisierung bestätigt werden soll.
actionCodeSettings ActionCodeSettings | null ActionCodeSettings

Gibt zurück:

Promise<void>

Beispiel

const 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
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

Funktion(userCredential, ...)

getAdditionalUserInfo(userCredential)

Extrahiert anbieterspezifische AdditionalUserInfo für die angegebenen Anmeldedaten.

Unterschrift:

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

Parameter

Parameter Typ Beschreibung
userCredential UserCredential Die Anmeldedaten des Nutzers.

Gibt zurück:

AdditionalUserInfo | null

ActionCodeOperation

Eine Aufzählung der möglichen E-Mail-Aktionstypen.

Unterschrift:

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

AuthErrorCodes

Eine Übersicht potenzieller Auth-Fehlercodes für einen einfacheren Vergleich mit Fehlern, die vom SDK ausgegeben werden.

Beachten Sie, dass Sie keine einzelnen Schlüssel in der Map durch einen Baum schütteln können. Durch die Verwendung der Map können Sie also die Bundle-Größe erheblich erhöhen.

Unterschrift:

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

browserLocalPersistence

Eine Implementierung von Persistence vom Typ LOCAL unter Verwendung von localStorage für den zugrunde liegenden Speicher.

Unterschrift:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

Eine für browserbasierte Anwendungen geeignete Implementierung von PopupRedirectResolver.

Diese Methode funktioniert nicht in einer Node.js-Umgebung.

Unterschrift:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Eine Implementierung von Persistence von SESSION unter Verwendung von sessionStorage für den zugrunde liegenden Speicher.

Unterschrift:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Eine Implementierung von PopupRedirectResolver, die für Cordova-basierte Anwendungen geeignet ist.

Unterschrift:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

Eine ausführliche Fehlerkarte mit detaillierten Beschreibungen für die meisten Fehlercodes.

Diskussion unter AuthErrorMap ansehen

Unterschrift:

debugErrorMap: AuthErrorMap

FactorId

Eine Aufzählung von Faktoren, die für die Multi-Faktor-Authentifizierung verwendet werden können.

Unterschrift:

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

indexedDBLocalPersistence

Eine Implementierung von Persistence vom Typ LOCAL unter Verwendung von indexedDB für den zugrunde liegenden Speicher.

Unterschrift:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

Eine Implementierung von Persistence vom Typ 'NONE'.

Unterschrift:

inMemoryPersistence: Persistence

OperationType

Aufzählung der unterstützten Vorgangstypen.

Unterschrift:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

prodErrorMap

Eine Übersicht der minimalen Fehler ohne alle ausführlichen Fehlermeldungen.

Diskussion unter AuthErrorMap ansehen

Unterschrift:

prodErrorMap: AuthErrorMap

ProviderId

Aufzählung der unterstützten Anbieter.

Unterschrift:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

SignInMethod

Aufzählung der unterstützten Anmeldemethoden.

Unterschrift:

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

CustomParameters

Zuordnung von benutzerdefinierten OAuth-Parametern.

Unterschrift:

export declare type CustomParameters = Record<string, string>;

NextOrObserver

Typdefinition für einen Ereignis-Callback.

Unterschrift:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

PhoneInfoOptions

Die Informationen, die erforderlich sind, um die Inhaberschaft einer Telefonnummer zu bestätigen.

Welche Informationen erforderlich sind, hängt davon ab, ob Sie die Einzel-Faktor-Anmeldung, die Multi-Faktor-Registrierung oder die Multi-Faktor-Anmeldung durchführen.

Unterschrift:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

In AdditionalUserInfo verwendetes Nutzerprofil

Unterschrift:

export declare type UserProfile = Record<string, unknown>;