auth package

Firebase-Authentifizierung

Funktionen

Funktion Beschreibung
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.
initializeAuth(app, deps) Initialisiert eine Auth- Instanz mit differenzierter Kontrolle über Abhängigkeiten .
Funktion (Speicher, ...)
getReactNativePersistence(Speicher) Gibt ein Persistenzobjekt zurück, das AsyncStorage umschließt, das aus react-native oder @react-native-community/async-storage importiert wurde, und im Persistenzabhängigkeitsfeld in initializeAuth() verwendet werden kann. .
Funktion(auth, ...)
applyActionCode(auth, oobCode) Wendet einen Bestätigungscode an, der per E-Mail oder einem anderen Out-of-Band-Mechanismus an den Benutzer gesendet wird.
beforeAuthStateChanged(auth, callback, onAbort) Fügt einen blockierenden Rückruf hinzu, der ausgeführt wird, bevor eine Änderung des Authentifizierungsstatus einen neuen Benutzer festlegt.
checkActionCode(auth, oobCode) Überprüft einen Bestätigungscode, der per E-Mail oder einem anderen Out-of-Band-Mechanismus an den Benutzer gesendet wird.
bestätigenPasswordReset(auth, oobCode, newPassword) Schließt den Vorgang zum Zurücksetzen des Passworts mit einem Bestätigungscode und einem neuen Passwort ab.
connectAuthEmulator(auth, url, Optionen) Ändert die Auth- Instanz so, dass sie mit dem Firebase Auth-Emulator statt mit Firebase Auth-Produktivdiensten kommuniziert.
createUserWithEmailAndPassword(auth, email, passwort) Erstellt ein neues Benutzerkonto, das der angegebenen E-Mail-Adresse und dem angegebenen Passwort zugeordnet 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 [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist, unabhängig von der Anzahl der verfügbaren Authentifizierungsmethoden angegebene E-Mail.
getMultiFactorResolver(auth, Fehler) Stellt einen MultiFactorResolver bereit, der für die Vervollständigung eines Multi-Faktor-Flusses geeignet ist.
getRedirectResult(auth, Resolver) Gibt ein UserCredential aus dem umleitungsbasierten Anmeldefluss zurück.
initializeRecaptchaConfig(auth) Lädt die reCAPTCHA-Konfiguration in die Auth Instanz.
isSignInWithEmailLink(auth, emailLink) Überprüft, ob es sich bei einem eingehenden Link um einen Link zur Anmeldung mit E-Mail handelt, der für signInWithEmailLink() geeignet ist. .
onAuthStateChanged(auth, nextOrObserver, Fehler, abgeschlossen) Fügt einen Beobachter für Änderungen am Anmeldestatus des Benutzers hinzu.
onIdTokenChanged(auth, nextOrObserver, Fehler, abgeschlossen) Fügt einen Beobachter für Änderungen am ID-Token des angemeldeten Benutzers hinzu.
revokeAccessToken(auth, token) Widerruft das angegebene Zugriffstoken. Unterstützt derzeit nur Apple OAuth-Zugriffstoken.
sendPasswordResetEmail(auth, email, actionCodeSettings) Sendet eine E-Mail zum Zurücksetzen des Passworts an die angegebene E-Mail-Adresse. Diese Methode gibt keinen Fehler aus, wenn kein Benutzerkonto mit der angegebenen E-Mail-Adresse vorhanden ist und [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist .
sendSignInLinkToEmail(auth, email, actionCodeSettings) Sendet einen Anmelde-E-Mail-Link an den Benutzer mit der angegebenen E-Mail-Adresse.
setPersistence(auth, persistence) Ändert den Typ der Persistenz auf der Auth- Instanz für die aktuell gespeicherte Auth Sitzung und wendet diesen Typ der Persistenz auf zukünftige Anmeldeanfragen an, einschließlich der Anmeldung mit Umleitungsanfragen.
signInAnonymously(auth) Meldet sich asynchron als anonymer Benutzer an.
signInWithCredential(auth, credential) Meldet sich asynchron mit den angegebenen Anmeldeinformationen an.
signInWithCustomToken(auth, customToken) Meldet sich asynchron mit einem benutzerdefinierten Token an.
signInWithEmailAndPassword(Authentifizierung, E-Mail, Passwort) Meldet sich asynchron mit einer E-Mail-Adresse und einem Passwort an.
signInWithEmailLink(auth, email, emailLink) Meldet sich asynchron über eine E-Mail und einen Anmelde-E-Mail-Link an.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) Meldet sich asynchron mit einer Telefonnummer an.
signInWithPopup(auth, Provider, Resolver) Authentifiziert einen Firebase-Client mithilfe eines Popup-basierten OAuth-Authentifizierungsablaufs.
signInWithRedirect(auth, Provider, Resolver) Authentifiziert einen Firebase-Client mithilfe eines ganzseitigen Umleitungsflusses.
signOut(auth) Meldet den aktuellen Benutzer ab.
updateCurrentUser(auth, user) Legt den bereitgestellten Benutzer asynchron als Auth.currentUser auf der Auth- Instanz fest.
useDeviceLanguage(auth) Setzt die aktuelle Sprache auf die Standardeinstellung für Gerät/Browser.
validierenPasswort(auth, passwort) Validiert das Passwort anhand der für das Projekt oder den Mandanten konfigurierten Passwortrichtlinie.
verifyPasswordResetCode(auth, code) Überprüft einen Passwort-Reset-Code, der dem Benutzer per E-Mail oder einem anderen Out-of-Band-Mechanismus gesendet wird.
Funktion(Link, ...)
parseActionCodeURL(Link) Analysiert die Linkzeichenfolge der E-Mail-Aktion und gibt eine ActionCodeURL zurück, wenn der Link gültig ist, andernfalls wird null zurückgegeben.
Funktion(Benutzer, ...)
deleteUser(Benutzer) Löscht und meldet den Benutzer ab.
getIdToken(Benutzer, ForceRefresh) Gibt ein JSON-Web-Token (JWT) zurück, das zur Identifizierung des Benutzers gegenüber einem Firebase-Dienst verwendet wird.
getIdTokenResult(user, forceRefresh) Gibt ein deserialisiertes JSON Web Token (JWT) zurück, das zur Identifizierung des Benutzers gegenüber einem Firebase-Dienst verwendet wird.
linkWithCredential(Benutzer, Anmeldeinformationen) Verknüpft das Benutzerkonto mit den angegebenen Anmeldeinformationen.
linkWithPhoneNumber(user, phoneNumber, appVerifier) Verknüpft das Benutzerkonto mit der angegebenen Telefonnummer.
linkWithPopup(Benutzer, Anbieter, Resolver) Verknüpft den authentifizierten Anbieter mithilfe eines Popup-basierten OAuth-Ablaufs mit dem Benutzerkonto.
linkWithRedirect(Benutzer, Anbieter, Resolver) Verknüpft den OAuthProvider über einen ganzseitigen Umleitungsfluss mit dem Benutzerkonto.
multiFactor(Benutzer) Der MultiFactorUser , der dem Benutzer entspricht.
reauthenticateWithCredential(user, credential) Authentifiziert einen Benutzer erneut mit neuen Anmeldeinformationen.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) Authentifiziert einen Benutzer erneut mit neuen Telefonanmeldeinformationen.
reauthenticateWithPopup(Benutzer, Anbieter, Resolver) Authentifiziert den aktuellen Benutzer erneut mit dem angegebenen OAuthProvider mithilfe eines Popup-basierten OAuth-Ablaufs.
reauthenticateWithRedirect(Benutzer, Anbieter, Resolver) Authentifiziert den aktuellen Benutzer erneut mit dem angegebenen OAuthProvider mithilfe eines ganzseitigen Umleitungsflusses.
neu laden (Benutzer) Lädt die Benutzerkontodaten neu, wenn Sie angemeldet sind.
sendEmailVerification(user, actionCodeSettings) Sendet eine Bestätigungs-E-Mail an einen Benutzer.
unlink(Benutzer, Anbieter-ID) Hebt die Verknüpfung eines Anbieters mit einem Benutzerkonto auf.
updateEmail(Benutzer, newEmail) Aktualisiert die E-Mail-Adresse des Benutzers.
updatePassword(Benutzer, neuesPasswort) Aktualisiert das Passwort des Benutzers.
updatePhoneNumber(Benutzer, Anmeldeinformationen) Aktualisiert die Telefonnummer des Benutzers.
updateProfile(user, { displayName, photoURL: photoUrl }) Aktualisiert die Profildaten eines Benutzers.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) Sendet eine Bestätigungs-E-Mail an eine neue E-Mail-Adresse.
Funktion(userCredential, ...)
getAdditionalUserInfo(userCredential) Extrahiert anbieterspezifische AdditionalUserInfo für die angegebenen Anmeldeinformationen.

Klassen

Klasse Beschreibung
ActionCodeURL Eine Dienstprogrammklasse zum Parsen von E-Mail-Aktions-URLs wie Passwortzurücksetzung, E-Mail-Verifizierung, E-Mail-Link-Anmeldung usw.
AuthCredential Schnittstelle, die die von einem AuthProvider zurückgegebenen Anmeldeinformationen darstellt .
EmailAuthCredential Schnittstelle, die die von EmailAuthProvider für ProviderId zurückgegebenen Anmeldeinformationen darstellt .PASSWORT
EmailAuthProvider Anbieter zum Generieren von EmailAuthCredential .
FacebookAuthProvider Anbieter zum Generieren eines OAuthCredential für ProviderId .FACEBOOK.
GithubAuthProvider Anbieter zum Generieren eines OAuthCredential für ProviderId .GITHUB.
GoogleAuthProvider Anbieter zum Generieren eines OAuthCredential für ProviderId .GOOGLE.
OAuthCredential Stellt die von einem OAuthProvider zurückgegebenen OAuth-Anmeldeinformationen dar .
OAuthProvider Anbieter zum Generieren von generischem OAuthCredential .
PhoneAuthCredential Stellt die von PhoneAuthProvider zurückgegebenen Anmeldeinformationen dar .
PhoneAuthProvider Anbieter zum Generieren eines PhoneAuthCredential .
PhoneMultiFactorGenerator Anbieter zum Generieren einer PhoneMultiFactorAssertion .
RecaptchaVerifier Ein reCAPTCHA -basierter Anwendungsverifizierer.
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 eines OAuthCredential für ProviderId .TWITTER.

Schnittstellen

Schnittstelle Beschreibung
ActionCodeInfo Eine Antwort von checkActionCode() .
ActionCodeSettings Eine Schnittstelle, die die erforderliche Fortsetzungs-/Status-URL mit optionalen Android- und iOS-Bundle-IDs definiert.
AdditionalUserInfo Eine Struktur, die zusätzliche Benutzerinformationen von einem föderierten Identitätsanbieter enthält.
ApplicationVerifier Ein Verifizierer zur Domainverifizierung und Missbrauchsprävention.
Auth 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 zur Erleichterung der Erstellung von AuthCredential verwendet wird .
AuthSettings Schnittstelle, die die Einstellungen einer Auth- Instanz darstellt.
Konfig Schnittstelle, die die Auth Konfiguration darstellt.
Bestätigungsergebnis Ein Ergebnis einer Telefonnummernanmeldung, eines Links oder eines erneuten Authentifizierungsanrufs.
Abhängigkeiten Die Abhängigkeiten, die zum Initialisieren einer Auth- Instanz verwendet werden können.
EmulatorConfig Konfiguration des Firebase-Authentifizierungsemulators.
IdTokenResult Schnittstelle, die das von User.getIdTokenResult() erhaltene ID-Token-Ergebnis darstellt .
MultiFactorAssertion Die Basisklasse zur Geltendmachung des Besitzes eines zweiten Faktors.
MultiFactorError Der Fehler wird ausgegeben, wenn der Benutzer für eine erfolgreiche Anmeldung einen zweiten Faktor angeben muss.
MultiFactorInfo Eine Struktur, die die Informationen einer zweiten Faktorentität enthält.
MultiFactorResolver Die Klasse, die zur Erleichterung der Wiederherstellung nach MultiFactorError verwendet wird, wenn ein Benutzer zum Anmelden einen zweiten Faktor angeben muss.
MultiFactorSession Eine Schnittstelle, die das Multi-Faktor-Sitzungsobjekt definiert, das zum Registrieren eines zweiten Faktors für einen Benutzer oder zum Helfen bei der Anmeldung eines registrierten Benutzers mit einem zweiten Faktor verwendet wird.
MultiFactorUser Eine Schnittstelle, die die multifaktorbezogenen Eigenschaften und Vorgänge eines Benutzers definiert .
OAuthCredentialOptions Definiert die Optionen zum Initialisieren eines OAuthCredential .
ParsedToken Schnittstelle, die ein analysiertes ID-Token darstellt.
Kennwortrichtlinie Eine Struktur, die die Anforderungen der Kennwortrichtlinie angibt.
PasswordValidationStatus Eine Struktur, die angibt, welche Passwortrichtlinienanforderungen erfüllt oder verletzt wurden und welche Anforderungen bestehen.
Beharrlichkeit Eine Schnittstelle, die die möglichen Arten von Persistenzmechanismen abdeckt.
PhoneMultiFactorAssertion Die Klasse zur Geltendmachung des Besitzes eines zweiten Telefonfaktors. Bereitgestellt von PhoneMultiFactorGenerator.assertion() .
PhoneMultiFactorEnrollInfoOptions Optionen für die Registrierung eines zweiten Faktors.
PhoneMultiFactorInfo Die Unterklasse der MultiFactorInfo- Schnittstelle für Telefonnummern-Sekundenfaktoren. Die factorId dieses zweiten Faktors ist FactorId .TELEFON.
PhoneMultiFactorSignInInfoOptions Optionen für die Anmeldung mit einem zweiten Faktor.
PhoneSingleFactorInfoOptions Optionen für die Einzelfaktor-Anmeldung.
PopupRedirectResolver Ein Resolver zur Verarbeitung DOM-spezifischer Vorgänge wie signInWithPopup() oder signInWithRedirect() .
ReactNativeAsyncStorage Schnittstelle für einen bereitgestellten AsyncStorage .
RecaptchaParameters Schnittstelle, die reCAPTCHA-Parameter darstellt. Die Liste der akzeptierten Parameter finden Sie in den [reCAPTCHA-Dokumenten](https://developers.google.com/recaptcha/docs/display#render_param). Alle Parameter außer sitekey werden akzeptiert: Firebase Auth stellt für jedes Projekt ein reCAPTCHA bereit und konfiguriert den Site-Schlüssel beim Rendern. Für ein unsichtbares reCAPTCHA setzen Sie den size auf invisible .
TotpMultiFactorAssertion Die Klasse zur Geltendmachung des Besitzes eines zweiten TOTP-Faktors. Bereitgestellt von TotpMultiFactorGenerator.assertionForEnrollment() und TotpMultiFactorGenerator.assertionForSignIn() .
TotpMultiFactorInfo Die Unterklasse der MultiFactorInfo- Schnittstelle für TOTP-Sekundenfaktoren. Die factorId dieses zweiten Faktors ist FactorId .TOTP.
Benutzer Ein Benutzerkonto.
Benutzeranmeldeinformationen Eine Struktur, die einen Benutzer enthält , der OperationType und die Provider-ID.
Benutzerinformation Benutzerprofilinformationen, nur für die Apps des Firebase-Projekts sichtbar.
Benutzermetadaten Schnittstelle, die die Metadaten eines Benutzers darstellt.

Variablen

Variable Beschreibung
ActionCodeOperation Eine Aufzählung der möglichen E-Mail-Aktionstypen.
AuthErrorCodes Eine Karte potenzieller Auth Fehlercodes zum 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 Implementierung von PopupRedirectResolver , die für browserbasierte Anwendungen geeignet ist.
browserSessionPersistence Eine Implementierung der Persistenz 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
Faktor-ID Eine Aufzählung von Faktoren, die für die Multifaktor-Authentifizierung verwendet werden können.
indexedDBLocalPersistence Eine Implementierung von Persistenz vom Typ LOCAL unter Verwendung indexedDB für den zugrunde liegenden Speicher.
inMemoryPersistence Eine Implementierung der Persistenz vom Typ „NONE“.
Operationstyp Aufzählung der unterstützten Vorgangstypen.
prodErrorMap Eine minimale Fehlerzuordnung, bei der alle ausführlichen Fehlermeldungen entfernt wurden. Siehe Diskussion unter AuthErrorMap
Anbieter-ID Aufzählung der unterstützten Anbieter.
SignInMethod Aufzählung der unterstützten Anmeldemethoden.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
BenutzerdefinierteParameter Karte der benutzerdefinierten OAuth-Parameter.
NextOrObserver Typdefinition für einen Ereignisrückruf.
PhoneInfoOptions Die Informationen, die zur Überprüfung des Besitzes einer Telefonnummer erforderlich sind.
Benutzerprofil Benutzerprofil, das in AdditionalUserInfo verwendet wird .

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.

Kehrt zurück:

Auth

initializeAuth(app, deps)

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

Diese Funktion ermöglicht mehr Kontrolle über die Auth- Instanz als getAuth() . getAuth verwendet plattformspezifische Standardeinstellungen, um die Abhängigkeiten bereitzustellen . Im Allgemeinen ist getAuth die einfachste Möglichkeit, Auth zu initialisieren und funktioniert für die meisten Anwendungsfälle. Verwenden Sie initializeAuth wenn Sie Kontrolle darüber benötigen, welche Persistenzschicht verwendet wird, oder um die Bundle-Größe zu minimieren, wenn Sie weder signInWithPopup noch signInWithRedirect verwenden .

Wenn Ihre App beispielsweise nur anonyme Konten verwendet 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
deps Abhängigkeiten

Kehrt zurück:

Auth

Funktion (Speicher, ...)

getReactNativePersistence(Speicher)

Gibt ein Persistenzobjekt zurück, das AsyncStorage umschließt, das aus react-native oder @react-native-community/async-storage importiert wurde und kann im Persistenzabhängigkeitsfeld in initializeAuth() verwendet werden. .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Lagerung ReactNativeAsyncStorage

Kehrt zurück:

Beharrlichkeit

Funktion(auth, ...)

applyActionCode(auth, oobCode)

Wendet einen Bestätigungscode an, der per E-Mail oder einem anderen Out-of-Band-Mechanismus an den Benutzer gesendet wird.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
oobCode Zeichenfolge Ein an den Benutzer gesendeter Bestätigungscode.

Kehrt zurück:

Versprechen<void>

beforeAuthStateChanged(auth, callback, onAbort)

Fügt einen blockierenden Rückruf hinzu, der ausgeführt wird, bevor eine Änderung des Authentifizierungsstatus einen neuen Benutzer festlegt.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Ruf zurück (Benutzer: Benutzer | null) => void | Versprechen<void> Rückruf wird ausgelöst, bevor ein neuer Benutzerwert festgelegt wird. Wenn dies ausgelöst wird, wird verhindert, dass der Benutzer festgelegt wird.
onAbort () => ungültig Der Rückruf wird ausgelöst, wenn ein späterer beforeAuthStateChanged() -Rückruf ausgelöst wird, sodass Sie alle Nebenwirkungen rückgängig machen können.

Kehrt zurück:

Abbestellen

checkActionCode(auth, oobCode)

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
oobCode Zeichenfolge Ein an den Benutzer gesendeter Bestätigungscode.

Kehrt zurück:

Versprechen< ActionCodeInfo >

Metadaten zum Code.

bestätigenPasswordReset(auth, oobCode, newPassword)

Schließt den Vorgang zum Zurücksetzen des Passworts mit einem Bestätigungscode und einem neuen Passwort ab.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
oobCode Zeichenfolge Ein an den Benutzer gesendeter Bestätigungscode.
Neues Kennwort Zeichenfolge Das neue Passwort.

Kehrt zurück:

Versprechen<void>

connectAuthEmulator(auth, url, Optionen)

Ändert die Auth- Instanz so, dass sie mit dem Firebase Auth-Emulator statt mit Firebase Auth-Produktivdiensten kommuniziert.

Dies muss synchron unmittelbar nach dem ersten Aufruf von initializeAuth() aufgerufen werden. . Nicht mit Produktionsanmeldeinformationen verwenden, da der Emulatordatenverkehr nicht verschlüsselt ist.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
URL Zeichenfolge 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 . Setzen Sie es auf true , um das an das DOM angehängte Warnbanner zu deaktivieren.

Kehrt zurück:

Leere

Beispiel

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

createUserWithEmailAndPassword(auth, email, passwort)

Erstellt ein neues Benutzerkonto, das der angegebenen E-Mail-Adresse und dem angegebenen Passwort zugeordnet ist.

Nach erfolgreicher Erstellung des Benutzerkontos wird dieser Benutzer auch in Ihrer Anwendung angemeldet.

Die Erstellung eines Benutzerkontos kann fehlschlagen, wenn das Konto bereits existiert oder das Passwort ungültig ist.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Email Zeichenfolge Die E-Mail-Adresse des Benutzers.
Passwort Zeichenfolge Das vom Benutzer gewählte Passwort.

Kehrt zurück:

Versprechen< 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 [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist, unabhängig von der Anzahl der verfügbaren Authentifizierungsmethoden angegebene E-Mail.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Email Zeichenfolge Die E-Mail-Adresse des Benutzers. Veraltet. Als bewährte Sicherheitsmethode wird die Abkehr von dieser Methode empfohlen. Weitere Informationen finden Sie in der Identity Platform-Dokumentation für [Email Enumeration Protection] (https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

Kehrt zurück:

Versprechen<string[]>

getMultiFactorResolver(auth, Fehler)

Stellt einen MultiFactorResolver bereit, der für die Vervollständigung eines Multi-Faktor-Flusses geeignet ist.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Fehler MultiFactorError Der MultiFactorError wurde während einer Anmeldung oder eines erneuten Authentifizierungsvorgangs ausgelöst.

Kehrt zurück:

MultiFactorResolver

getRedirectResult(auth, Resolver)

Gibt ein UserCredential aus dem umleitungsbasierten Anmeldefluss zurück.

Wenn die Anmeldung erfolgreich war, wird der angemeldete Benutzer zurückgegeben. Wenn die Anmeldung nicht erfolgreich war, wird ein Fehler angezeigt. Wenn kein Umleitungsvorgang aufgerufen wurde, wird null zurückgegeben .

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

Unterschrift:

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

Parameter

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

Kehrt zurück:

Versprechen< 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 Auth Instanz.

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

Wenn initializeRecaptchaConfig() nicht aufgerufen wird, startet der Authentifizierungsfluss immer ohne reCAPTCHA-Überprüfung. Wenn der Anbieter so konfiguriert ist, dass eine reCAPTCHA-Überprüfung erforderlich ist, lädt das SDK die reCAPTCHA-Konfiguration transparent und startet die Authentifizierungsflüsse neu.

Durch den Aufruf dieser optionalen Methode reduzieren Sie also die Latenz zukünftiger Authentifizierungsflüsse. Durch das frühzeitige 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
Autor Auth Die Auth- Instanz.

Kehrt zurück:

Versprechen<void>

Beispiel

initializeRecaptchaConfig(auth);

Überprüft, ob es sich bei einem eingehenden Link um einen Link zur Anmeldung mit E-Mail handelt, der für signInWithEmailLink() geeignet ist. .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
emailLink Zeichenfolge Der an die E-Mail-Adresse des Benutzers gesendete Link.

Kehrt zurück:

Boolescher Wert

onAuthStateChanged(auth, nextOrObserver, Fehler, abgeschlossen)

Fügt einen Beobachter für Änderungen am Anmeldestatus des Benutzers 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
Autor Auth Die Auth- Instanz.
nextOrObserver NextOrObserver < Benutzer > Rückruf wird bei Änderung ausgelöst.
Fehler ErrorFn Veraltet. Dieser Rückruf wird nie ausgelöst. Fehler beim Anmelden/Abmelden können in Versprechen abgefangen werden, die von Anmelde-/Abmeldefunktionen zurückgegeben werden.
vollendet CompleteFn Veraltet. Dieser Rückruf wird nie ausgelöst.

Kehrt zurück:

Abbestellen

onIdTokenChanged(auth, nextOrObserver, Fehler, abgeschlossen)

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

Dazu gehören Anmelde-, Abmelde- und Tokenaktualisierungsereignisse. Dies 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
Autor Auth Die Auth- Instanz.
nextOrObserver NextOrObserver < Benutzer > Rückruf wird bei Änderung ausgelöst.
Fehler ErrorFn Veraltet. Dieser Rückruf wird nie ausgelöst. Fehler beim Anmelden/Abmelden können in Versprechen abgefangen werden, die von Anmelde-/Abmeldefunktionen zurückgegeben werden.
vollendet CompleteFn Veraltet. Dieser Rückruf wird nie ausgelöst.

Kehrt zurück:

Abbestellen

revokeAccessToken(auth, token)

Widerruft das angegebene Zugriffstoken. Unterstützt derzeit nur Apple OAuth-Zugriffstoken.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Zeichen Zeichenfolge Das Apple OAuth-Zugriffstoken.

Kehrt zurück:

Versprechen<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Sendet eine E-Mail zum Zurücksetzen des Passworts an die angegebene E-Mail-Adresse. Diese Methode gibt keinen Fehler aus, wenn kein Benutzerkonto mit der angegebenen E-Mail-Adresse vorhanden ist und [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist .

Um das Zurücksetzen des Passworts abzuschließen, rufen Sie „firmifyPasswordReset()“ mit dem in der an den Benutzer gesendeten E-Mail angegebenen Code und dem vom Benutzer angegebenen neuen Passwort auf.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Email Zeichenfolge Die E-Mail-Adresse des Benutzers.
actionCodeSettings ActionCodeSettings Die ActionCodeSettings .

Kehrt zurück:

Versprechen<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 einen Anmelde-E-Mail-Link an den Benutzer mit der angegebenen E-Mail-Adresse.

Im Gegensatz zu anderen Out-of-Band-E-Mail-Aktionen (Zurücksetzen des Passworts und E-Mail-Verifizierungen) muss der Anmeldevorgang immer in der App abgeschlossen werden. Dies liegt daran, dass am Ende des Ablaufs davon ausgegangen wird, dass der Benutzer angemeldet ist und sein Authentifizierungsstatus in der App bestehen bleibt.

Um die Anmeldung mit dem E-Mail-Link abzuschließen, rufen Sie signInWithEmailLink() mit der E-Mail-Adresse und dem E-Mail-Link auf, die in der an den Benutzer gesendeten E-Mail enthalten sind.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth
Email Zeichenfolge Die E-Mail-Adresse des Benutzers.
actionCodeSettings ActionCodeSettings Die ActionCodeSettings .

Kehrt zurück:

Versprechen<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 den Typ der Persistenz auf der Auth- Instanz für die aktuell gespeicherte Auth Sitzung und wendet diesen Typ der Persistenz auf zukünftige Anmeldeanfragen an, einschließlich der Anmeldung mit Umleitungsanfragen.

Dadurch kann ein Benutzer beim Anmelden ganz einfach angeben, ob seine Sitzung gespeichert werden soll oder nicht. Es macht es außerdem einfacher, den Auth Status für Anwendungen, die von anderen Benutzern gemeinsam genutzt werden oder über vertrauliche Daten verfügen, niemals beizubehalten.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Beharrlichkeit Beharrlichkeit Die zu verwendende Persistenz .

Kehrt zurück:

Versprechen<void>

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

Beispiel

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Meldet sich asynchron als anonymer Benutzer an.

Wenn bereits ein anonymer Benutzer angemeldet ist, wird dieser Benutzer zurückgegeben; andernfalls wird eine neue anonyme Benutzeridentität erstellt und zurückgegeben.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.

Kehrt zurück:

Versprechen< UserCredential >

signInWithCredential(auth, credential)

Meldet sich asynchron mit den angegebenen Anmeldeinformationen an.

Zur Generierung der Anmeldeinformationen kann ein AuthProvider verwendet werden.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Berechtigung AuthCredential Die Authentifizierungsdaten.

Kehrt zurück:

Versprechen< UserCredential >

signInWithCustomToken(auth, customToken)

Meldet sich asynchron mit einem benutzerdefinierten Token an.

Benutzerdefinierte Token werden zur Integration von Firebase Auth in bestehende Authentifizierungssysteme verwendet und müssen von einem Authentifizierungs-Backend mithilfe der Methode „createCustomToken“ im Admin SDK generiert werden.

Schlägt mit einem Fehler fehl, wenn das Token ungültig oder abgelaufen ist oder vom Firebase Auth-Dienst nicht akzeptiert wird.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
benutzerdefiniertesToken Zeichenfolge Das benutzerdefinierte Token für die Anmeldung.

Kehrt zurück:

Versprechen< UserCredential >

signInWithEmailAndPassword(Authentifizierung, E-Mail, Passwort)

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

Schlägt mit einem Fehler fehl, wenn E-Mail-Adresse und Passwort nicht übereinstimmen. Wenn [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist, schlägt diese Methode im Falle einer Ungültigkeit mit „auth/invalid-credential“ fehl E-Mail Passwort.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Email Zeichenfolge Die E-Mail-Adresse des Benutzers.
Passwort Zeichenfolge Das Passwort des Benutzers.

Kehrt zurück:

Versprechen< UserCredential >

Meldet sich asynchron über eine E-Mail und einen Anmelde-E-Mail-Link an.

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

Schlägt mit einem Fehler fehl, wenn die E-Mail-Adresse ungültig ist oder das OTP im E-Mail-Link abläuft.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Email Zeichenfolge Die E-Mail-Adresse des Benutzers.
emailLink Zeichenfolge Der an die E-Mail-Adresse des Benutzers gesendete Link.

Kehrt zurück:

Versprechen< 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 mit einer Telefonnummer an.

Diese Methode sendet einen Code per SMS an die angegebene Telefonnummer und gibt ein Bestätigungsergebnis zurück . Nachdem der Benutzer den an sein Telefon gesendeten Code eingegeben hat, rufen Sie „ConfirmationResult.confirm()“ mit dem Code auf, um den Benutzer anzumelden.

Zur Missbrauchsprävention benötigt diese Methode auch einen ApplicationVerifier . Dieses SDK enthält eine reCAPTCHA-basierte Implementierung, RecaptchaVerifier . Diese Funktion kann auf anderen Plattformen funktionieren, die den RecaptchaVerifier nicht unterstützen (wie React Native), Sie müssen jedoch eine ApplicationVerifier- Implementierung eines Drittanbieters verwenden.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Telefonnummer Zeichenfolge Die Telefonnummer des Benutzers im E.164-Format (z. B. +16505550101).
appVerifier ApplicationVerifier Der ApplicationVerifier .

Kehrt zurück:

Versprechen< 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)

Authentifiziert einen Firebase-Client mithilfe eines Popup-basierten OAuth-Authentifizierungsablaufs.

Bei Erfolg wird der angemeldete Benutzer zusammen mit den Anmeldeinformationen des Anbieters zurückgegeben. Wenn die Anmeldung nicht erfolgreich war, wird ein Fehlerobjekt zurückgegeben, das zusätzliche Informationen zum Fehler enthält.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Anbieter AuthProvider Der Anbieter zur Authentifizierung. 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() übergeben oder von getAuth() bereitgestellt .

Kehrt zurück:

Versprechen< 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)

Authentifiziert einen Firebase-Client mithilfe eines ganzseitigen Umleitungsflusses.

Informationen zur Behandlung der Ergebnisse und Fehler für diesen Vorgang finden Sie unter getRedirectResult(). . Befolgen Sie die Best Practices bei der Verwendung von signInWithRedirect() .

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Anbieter AuthProvider Der Anbieter zur Authentifizierung. 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() übergeben oder von getAuth() bereitgestellt .

Kehrt zurück:

Versprochen <niemals>

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)

Meldet den aktuellen Benutzer ab.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.

Kehrt zurück:

Versprechen<void>

updateCurrentUser(auth, user)

Legt den bereitgestellten Benutzer asynchron als Auth.currentUser auf der Auth- Instanz fest.

Eine neue Instanzkopie des bereitgestellten Benutzers wird 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 Benutzer zu einem anderen Firebase-Projekt gehört.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Benutzer Benutzer | Null Der neue Benutzer .

Kehrt zurück:

Versprechen<void>

useDeviceLanguage(auth)

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.

Kehrt zurück:

Leere

validierenPasswort(auth, passwort)

Validiert das Passwort anhand der für das Projekt oder den Mandanten konfigurierten Passwortrichtlinie.

Wenn für die Auth Instanz keine Mandanten-ID festgelegt ist, verwendet diese Methode die für das Projekt konfigurierte Kennwortrichtlinie. 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 Authentifizierungsfluss fehlschlägt, weil ein übermitteltes Passwort nicht den Anforderungen der Passwortrichtlinie entspricht und diese Methode zuvor aufgerufen wurde, verwendet diese Methode bei einem erneuten Aufruf die aktuellste verfügbare Richtlinie.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Passwort Zeichenfolge Das zu validierende Passwort.

Kehrt zurück:

Versprechen< PasswordValidationStatus >

Beispiel

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

Überprüft einen Passwort-Reset-Code, der dem Benutzer per E-Mail oder einem anderen Out-of-Band-Mechanismus gesendet wird.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Autor Auth Die Auth- Instanz.
Code Zeichenfolge Ein an den Benutzer gesendeter Bestätigungscode.

Kehrt zurück:

Versprechen<string>

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

parseActionCodeURL(Link)

Analysiert die Linkzeichenfolge der E-Mail-Aktion 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
Verknüpfung Zeichenfolge

Kehrt zurück:

ActionCodeURL | Null

Funktion(Benutzer, ...)

deleteUser(Benutzer)

Löscht und meldet den Benutzer ab.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.

Kehrt zurück:

Versprechen<void>

getIdToken(Benutzer, ForceRefresh)

Gibt ein JSON-Web-Token (JWT) zurück, das zur Identifizierung des Benutzers gegenüber einem Firebase-Dienst verwendet wird.

Gibt das aktuelle Token zurück, wenn es nicht abgelaufen ist oder in den nächsten fünf Minuten nicht ablaufen wird. 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
Benutzer Benutzer Der Benutzer.
forceRefresh Boolescher Wert Erzwingen Sie die Aktualisierung unabhängig vom Ablauf des Tokens.

Kehrt zurück:

Versprechen<string>

getIdTokenResult(user, forceRefresh)

Gibt ein deserialisiertes JSON Web Token (JWT) zurück, das zur Identifizierung des Benutzers gegenüber einem Firebase-Dienst verwendet wird.

Gibt das aktuelle Token zurück, wenn es nicht abgelaufen ist oder in den nächsten fünf Minuten nicht ablaufen wird. 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
Benutzer Benutzer Der Benutzer.
forceRefresh Boolescher Wert Erzwingen Sie die Aktualisierung unabhängig vom Ablauf des Tokens.

Kehrt zurück:

Versprechen< IdTokenResult >

linkWithCredential(Benutzer, Anmeldeinformationen)

Verknüpft das Benutzerkonto mit den angegebenen Anmeldeinformationen.

Zur Generierung der Anmeldeinformationen kann ein AuthProvider verwendet werden.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Berechtigung AuthCredential Die Authentifizierungsdaten.

Kehrt zurück:

Versprechen< UserCredential >

linkWithPhoneNumber(user, phoneNumber, appVerifier)

Verknüpft das Benutzerkonto 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
Benutzer Benutzer Der Benutzer.
Telefonnummer Zeichenfolge Die Telefonnummer des Benutzers im E.164-Format (z. B. +16505550101).
appVerifier ApplicationVerifier Der ApplicationVerifier .

Kehrt zurück:

Versprechen< ConfirmationResult >

linkWithPopup(Benutzer, Anbieter, Resolver)

Verknüpft den authentifizierten Anbieter mithilfe eines Popup-basierten OAuth-Ablaufs mit dem Benutzerkonto.

Wenn die Verknüpfung erfolgreich ist, enthält das zurückgegebene Ergebnis den Benutzer und die Anmeldeinformationen 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
Benutzer Benutzer Der Benutzer.
Anbieter AuthProvider Der Anbieter zur Authentifizierung. 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() übergeben oder von getAuth() bereitgestellt .

Kehrt zurück:

Versprechen< 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(Benutzer, Anbieter, Resolver)

Verknüpft den OAuthProvider über einen ganzseitigen Umleitungsfluss mit dem Benutzerkonto.

Um die Ergebnisse und Fehler für diesen Vorgang zu bewältigen, siehe getRedirectresult () . Folgen Sie den Best Practices , wenn Sie LinkWitHedirect () verwenden .

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Anbieter AuthProvider Der Anbieter zu authentifizieren. Der Anbieter muss ein OAuthProvider sein . Nicht-OAUTH-Anbieter wie EmailAuthProvider werfen einen Fehler.
Resolver Popupredirectresolver Eine Instanz von popupredirectresolver , optional, wenn er bereits an InitializeAUTh () geliefert oder von getAuth () bereitgestellt wird .

Kehrt zurück:

Versprechen <nie>

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);

Multifaktor (Benutzer)

Der Multifaktoruser entspricht dem Benutzer.

Dies wird verwendet, um auf alle Multi-Factor-Eigenschaften und -Operationen im Zusammenhang mit dem Benutzer zuzugreifen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.

Kehrt zurück:

Multifaktoruser

ReauthenticateWithcredential (Benutzer, Anmeldeinformationen)

Neuauthentifiziert einen Benutzer mit einem neuen Anmeldeinformator erneut.

Verwenden Sie vor Operationen wie UpdatePassword () , für die Token aus den letzten Anmeldungsversuchen erforderlich ist. Diese Methode kann verwendet werden, um sich von einem Fehler CREDENTIAL_TOO_OLD_LOGIN_AGAIN zu wiederherzustellen, oder ein Fehler TOKEN_EXPIRED .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Anmeldeinformationen Authkrönt Der Auth Remone.

Kehrt zurück:

Versprechen < usercredential >

ReauthenticateWithPhoneNumber (Benutzer, PhoneNumber, Appverifier)

Neuauthentifiziert einen Benutzer mit einem frischen Telefonanmeldeingabe.

Verwenden Sie vor Operationen wie UpdatePassword () , für die Token aus den letzten Anmeldungsversuchen erforderlich ist.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Telefonnummer Zeichenfolge Die Telefonnummer des Benutzers im E.164 -Format (z. B. +165055550101).
Appverifier ApplicationVerififier Der ApplicationVerififier .

Kehrt zurück:

Versprechen < Bestätigung >

ReautustenticateWithPopup (Benutzer, Anbieter, Resolver)

Reautasticiert der aktuelle Benutzer mit dem angegebenen OAuthProvider mit einem Pop-up-basierten OAuth-Fluss.

Wenn die Neuausbenutzung erfolgreich ist, enthält das zurückgegebene Ergebnis den Benutzer und den Anmeldeinformationen des Anbieters.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Anbieter AuthProvider Der Anbieter zu authentifizieren. Der Anbieter muss ein OAuthProvider sein . Nicht-OAUTH-Anbieter wie EmailAuthProvider werfen einen Fehler.
Resolver Popupredirectresolver Eine Instanz von popupredirectresolver , optional, wenn er bereits an InitializeAUTh () geliefert oder von getAuth () bereitgestellt wird .

Kehrt zurück:

Versprechen < 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);

Reauthenticatewitredirect (Benutzer, Anbieter, Resolver)

Reautasticiert der aktuelle Benutzer mit dem angegebenen OAuthProvider mit einem ganzseitigen Umleitungsfluss.

Um die Ergebnisse und Fehler für diesen Vorgang zu bewältigen, siehe getRedirectresult () . Befolgen Sie die Best Practices , wenn Sie reauthenticate -witredirect () verwenden () .

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Anbieter AuthProvider Der Anbieter zu authentifizieren. Der Anbieter muss ein OAuthProvider sein . Nicht-OAUTH-Anbieter wie EmailAuthProvider werfen einen Fehler.
Resolver Popupredirectresolver Eine Instanz von popupredirectresolver , optional, wenn er bereits an InitializeAUTh () geliefert oder von getAuth () bereitgestellt wird .

Kehrt zurück:

Versprechen <nie>

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);

neu laden (Benutzer)

Laden Sie Benutzerkontodaten neu, falls sie angemeldet sind.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.

Kehrt zurück:

Versprechen <void>

sendEmailverification (Benutzer, ActionCodesettings)

Sendet eine Überprüfungs -E -Mail an einen Benutzer.

Der Überprüfungsprozess wird durch Aufrufen von applyActaceCode () abgeschlossen .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
ActionCodesettings ActionCodesettings | Null Die actioncodesestings .

Kehrt zurück:

Versprechen <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);

Verknüpfen Sie einen Anbieter von einem Benutzerkonto.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Providerid Zeichenfolge Der Anbieter zum Verknüpfen.

Kehrt zurück:

Versprechen < Benutzer >

UpdateMail (Benutzer, Newemail)

Aktualisiert die E -Mail -Adresse des Benutzers.

Eine E -Mail wird an die ursprüngliche E -Mail -Adresse gesendet (falls sie festgelegt wurde), mit der die Änderung der E -Mail -Adressen geändert werden kann, um sie vor dem Kontostand zu schützen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Neue e-mail Zeichenfolge Die neue E -Mail -Adresse. Auslöscht "Auth/Operation-Not-" -Fehler, wenn [E-Mail-Aufzählungschutz] (https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) aktiviert ist. Veraltet - Verwenden Sie stattdessen VerifyBeforeupdateemail () .

Kehrt zurück:

Versprechen <void>

UPDATEPASSWORD (Benutzer, NewPassword)

Aktualisiert das Kennwort des Benutzers.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Neues Kennwort Zeichenfolge Das neue Passwort.

Kehrt zurück:

Versprechen <void>

UpdatePhoneNumber (Benutzer, Anmeldeinformationen)

Aktualisiert die Telefonnummer des Benutzers.

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

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Anmeldeinformationen PhoneAuthcredential Eine Anmeldeinformation, die die neue Telefonnummer authentifiziert.

Kehrt zurück:

Versprechen <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 (Benutzer, {displayName, Photourl: Photourl})

Aktualisiert die Profildaten eines Benutzers.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
{displayName, Photourl: Photourl} {DisplayName ?: String | Null; Photourl ?: String | Null; }

Kehrt zurück:

Versprechen <void>

verifyBeUpdateemail (Benutzer, Newemail, ActionCodesettings)

Sendet eine Überprüfungs -E -Mail an eine neue E -Mail -Adresse.

Die E -Mail des Benutzers wird nach der Überprüfung auf die neue aktualisiert.

Wenn Sie über einen benutzerdefinierten E -Mail -Aktions -Handler verfügen, können Sie den Überprüfungsprozess durch den Aufrufen von ApplicaTActionCode () abschließen. .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzer Benutzer Der Benutzer.
Neue e-mail Zeichenfolge Die neue E -Mail -Adresse wird vor dem Update überprüft.
ActionCodesettings ActionCodesettings | Null Die actioncodesestings .

Kehrt zurück:

Versprechen <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 (Benutzerkrönt)

Extrahiert den Anbieterspezifisch zusätzlichemuserinfo für den angegebenen Anmeldeinformationen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Benutzerkrönt Benutzerkrönt Der Benutzeranmeldeinformationen.

Kehrt zurück:

Zusätzlich | 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 Karte potenzieller Auth -Fehlercodes, um einen leichteren Vergleich mit den vom SDK geworfenen Fehlern zu erhalten.

Beachten Sie, dass Sie einzelne Schlüssel in der Karte nicht baumern können. Durch die Verwendung der Karte können Sie Ihre Bündelgröße möglicherweise 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";
}

BrowserLocalPersistenz

Eine Implementierung der Persistenz von Typ LOCAL unter Verwendung von localStorage für die zugrunde liegende Speicherung.

Unterschrift:

browserLocalPersistence: Persistence

BrowserPopUpredirectresolver

Eine Implementierung von popupredirectresolver , die für browserbasierte Anwendungen geeignet sind.

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

Unterschrift:

browserPopupRedirectResolver: PopupRedirectResolver

BrowserSessionPersistenz

Eine Implementierung der Persistenz der SESSION mit sessionStorage für den zugrunde liegenden Speicher.

Unterschrift:

browserSessionPersistence: Persistence

CordovapopUpRedirectresolver

Eine Implementierung von popupredirectresolver, die für Cordova -basierte Anwendungen geeignet sind.

Unterschrift:

cordovaPopupRedirectResolver: PopupRedirectResolver

DEBUGERRORRORMAP

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

Siehe Diskussion bei Autherrormap

Unterschrift:

debugErrorMap: AuthErrorMap

FaktorId

Ein Auflauf von Faktoren, die für die Multifaktorauthentifizierung verwendet werden können.

Unterschrift:

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

IndexedDblocalPersistenz

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

Unterschrift:

indexedDBLocalPersistence: Persistence

InmemoryPersistenz

Eine Implementierung der Persistenz des Typs 'None'.

Unterschrift:

inMemoryPersistence: Persistence

OperationType

Aufzählung von unterstützten Betriebstypen.

Unterschrift:

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

Proderrormap

Eine minimale Fehlerkarte mit allen ausführlichen Fehlermeldungen.

Siehe Diskussion bei Autherrormap

Unterschrift:

prodErrorMap: AuthErrorMap

Providerid

Aufzählung von unterstützten Anbietern.

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 unterstützter Anmeldungen.

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

Karte der benutzerdefinierten Parameter von OAuth.

Unterschrift:

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

Nextorobserver

Geben Sie Definition für einen Ereignisrückruf ein.

Unterschrift:

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

TelefonInfoopions

Die Informationen zur Überprüfung des Eigentums einer Telefonnummer.

Die erforderlichen Informationen hängen davon ab, ob Sie Anmeldungen für Einzelfaktoren, Multi-Factor-Anmeldungen oder Multi-Faktor-Anmeldungen durchführen.

Unterschrift:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

Benutzerprofil

Benutzerprofil in zusätzlichemuserinfo verwendet .

Unterschrift:

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