Save the date for Firebase Demo Day 2024. Learn how to build and run modern, AI-powered apps users love. Learn more.

Diese Seite wurde von der Cloud Translation API übersetzt.

firebase-admin.auth package

Firebase-Authentifizierung.

Funktionen

Funktion	Beschreibung
getAuth(app)	Ruft den Authentifizierungsdienst für die Standard-App oder eine bestimmte App ab. `getAuth()` kann ohne Argumente aufgerufen werden, um auf den Auth- Dienst der Standard-App zuzugreifen, oder als `getAuth(app)` um auf den Auth- Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Klassen

Klasse	Beschreibung
Auth	Authentifizierungsdienst, der an die bereitgestellte App gebunden ist. Eine Auth-Instanz kann mehrere Mandanten haben.
BaseAuth	Gemeinsame übergeordnete Schnittstelle für `Auth` und `TenantAwareAuth` APIs.
MultiFactorInfo	Schnittstelle, die die allgemeinen Eigenschaften eines vom Benutzer registrierten zweiten Faktors darstellt.
MultiFactorSettings	Die multifaktorbezogenen Benutzereinstellungen.
PhoneMultiFactorInfo	Schnittstelle, die einen telefonspezifischen, vom Benutzer registrierten zweiten Faktor darstellt.
Projektkonfiguration	Stellt eine Projektkonfiguration dar.
ProjectConfigManager	Verwaltet (ruft und aktualisiert) die aktuelle Projektkonfiguration.
Mieter	Stellt eine Mandantenkonfiguration dar. Für die Mandantenfähigkeitsunterstützung ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation . Bevor die Mandantenfähigkeit in einem Google Cloud Identity Platform-Projekt verwendet werden kann, müssen Mandanten über die Cloud Console-Benutzeroberfläche für dieses Projekt zugelassen werden. Eine Mandantenkonfiguration stellt Informationen wie den Anzeigenamen, die Mandantenkennung und die E-Mail-Authentifizierungskonfiguration bereit. Für die Konfigurationsverwaltung des OIDC/SAML-Anbieters sollten `TenantAwareAuth` Instanzen anstelle eines `Tenant` verwendet werden, um die Liste der konfigurierten IdPs auf einem Mandanten abzurufen. Beachten Sie bei der Konfiguration dieser Anbieter, dass Mandanten Domänen auf der Whitelist und authentifizierte Umleitungs-URIs ihres übergeordneten Projekts erben. Alle anderen Einstellungen eines Mandanten werden ebenfalls übernommen. Diese müssen über die Cloud Console-Benutzeroberfläche verwaltet werden.
TenantAwareAuth	Mandantenfähige `Auth` , die zum Verwalten von Benutzern, zum Konfigurieren von SAML/OIDC-Anbietern, zum Generieren von E-Mail-Links zum Zurücksetzen von Passwörtern, zur E-Mail-Verifizierung usw. für bestimmte Mandanten verwendet wird. Für die Mandantenfähigkeitsunterstützung ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation . Jeder Mandant enthält seine eigenen Identitätsanbieter, Einstellungen und Benutzergruppen. Mit `TenantAwareAuth` können auch Benutzer für einen bestimmten Mandanten und entsprechende OIDC/SAML-Konfigurationen verwaltet werden, ID-Tokens für Benutzer, die bei einem bestimmten Mandanten angemeldet sind, überprüft werden und E-Mail-Aktionslinks können auch für Benutzer generiert werden, die zum Mandanten gehören. `TenantAwareAuth` Instanzen für eine bestimmte `tenantId` können durch Aufrufen von TenantManager.authForTenant() instanziiert werden. .
MieterManager	Definiert den Mandantenmanager, der zur Verwaltung mandantenbezogener Vorgänge verwendet wird. Das beinhaltet: Die Möglichkeit, Mandanten für das zugrunde liegende Projekt zu erstellen, zu aktualisieren, aufzulisten, abzurufen und zu löschen. Abrufen einer `TenantAwareAuth` Instanz zum Ausführen von Auth-bezogenen Vorgängen (Benutzerverwaltung, Anbieterkonfigurationsverwaltung, Token-Überprüfung, E-Mail-Link-Generierung usw.) im Kontext eines angegebenen Mandanten.
Benutzerinformation	Stellt die Informationen eines Benutzers von einem externen Identitätsanbieter wie Google oder Facebook dar.
Benutzermetadaten	Stellt die Metadaten eines Benutzers dar.
Benutzerdatensatz	Stellt einen Benutzer dar.

Schnittstellen

Schnittstelle	Beschreibung
ActionCodeSettings	Dies ist die Schnittstelle, die die erforderliche Fortsetzungs-/Status-URL mit optionalen Android- und iOS-Bundle-IDs definiert.
AllowByDefault	Definiert eine Richtlinie, die standardmäßig jede Region zulässt und nicht zugelassene Regionen zu einer Nichtzulassungsliste hinzufügt.
AllowByDefaultWrap	Gegenseitig exklusive SMS-Regionskonfiguration der AllowByDefault-Schnittstelle
Nur Zulassungsliste	Definiert eine Richtlinie, die Regionen nur zulässt, indem sie explizit einer Zulassungsliste hinzugefügt werden.
AllowlistOnlyWrap	Sich gegenseitig ausschließende SMS-Regionskonfiguration der AllowlistOnly-Schnittstelle
AuthProviderConfigFilter	Die Filterschnittstelle, die zum Auflisten von Anbieterkonfigurationen verwendet wird. Dies wird verwendet, wenn angegeben wird, wie konfigurierte Identitätsanbieter über BaseAuth.listProviderConfigs() aufgelistet werden. .
BaseAuthProviderConfig	Die Konfigurationsschnittstelle des Basisauthentifizierungsanbieters.
BaseCreateMultiFactorInfoRequest	Schnittstelle, die Basiseigenschaften eines vom Benutzer registrierten zweiten Faktors für eine `CreateRequest` darstellt.
BaseUpdateMultiFactorInfoRequest	Schnittstelle, die allgemeine Eigenschaften eines vom Benutzer registrierten zweiten Faktors für einen `UpdateRequest` darstellt.
CreatePhoneMultiFactorInfoRequest	Schnittstelle, die einen telefonspezifischen, vom Benutzer registrierten zweiten Faktor für eine `CreateRequest` darstellt.
CreateRequest	Schnittstelle, die die Eigenschaften darstellt, die für einen neu zu erstellenden Benutzerdatensatz festgelegt werden sollen.
CustomStrengthOptionsConfig	Einschränkungen, die für die Passwortrichtlinie durchgesetzt werden müssen
DecodedIdToken	Schnittstelle, die ein decodiertes Firebase-ID-Token darstellt, das von der BaseAuth.verifyIdToken()- Methode zurückgegeben wird. Firebase-ID-Tokens sind JSON-Web-Tokens (JWTs), die der OpenID Connect-Spezifikation entsprechen. Weitere Informationen zu den spezifischen Eigenschaften unten finden Sie im [Abschnitt „ID-Token“ der OpenID Connect-Spezifikation](http://openid.net/specs/openid-connect-core-1_0.html#IDToken).
DeleteUsersResult	Stellt das Ergebnis von BaseAuth.deleteUsers() dar. . API.
EmailIdentifier	Wird zum Nachschlagen eines Kontos per E-Mail verwendet. Siehe BaseAuth.getUsers() .
EmailPrivacyConfig	Die E-Mail-Datenschutzkonfiguration eines Projekts oder Mandanten.
EmailSignInProviderConfig	Die Konfiguration des E-Mail-Anmeldeanbieters.
GetUsersResult	Stellt das Ergebnis der BaseAuth.getUsers() -API dar.
ListProviderConfigResults	Die Antwortschnittstelle zum Auflisten von Anbieterkonfigurationen. Dies ist nur verfügbar, wenn alle Konfigurationen von Identitätsanbietern über BaseAuth.listProviderConfigs() aufgelistet werden. .
ListTenantsResult	Schnittstelle, die das von einer TenantManager.listTenants() -Operation zurückgegebene Objekt darstellt. Enthält die Liste der Mandanten für den aktuellen Stapel und das Token für die nächste Seite, falls verfügbar.
ListUsersResult	Schnittstelle, die das von einer BaseAuth.listUsers() -Operation zurückgegebene Objekt darstellt. Enthält die Liste der Benutzer für den aktuellen Stapel und das Token für die nächste Seite, falls verfügbar.
MultiFactorConfig	Schnittstelle, die eine Multi-Faktor-Konfiguration darstellt. Hiermit kann definiert werden, ob die Multi-Faktor-Authentifizierung aktiviert oder deaktiviert ist, sowie die Liste der unterstützten Zwei-Faktor-Herausforderungen.
MultiFactorCreateSettings	Die multifaktorbezogenen Benutzereinstellungen für Erstellungsvorgänge.
MultiFactorProviderConfig	Schnittstelle, die eine Multi-Faktor-Authentifizierungsanbieterkonfiguration darstellt. Diese Schnittstelle wird für andere Zweitfaktor-Authentifizierungsanbieter als SMS verwendet. Derzeit wird nur TOTP unterstützt.
MultiFactorUpdateSettings	Die multifaktorbezogenen Benutzereinstellungen für Aktualisierungsvorgänge.
OAuthResponseType	Die Schnittstelle, die das Antwortobjekt des OIDC-Anbieters für den OAuth-Autorisierungsfluss darstellt. Eine der folgenden Einstellungen ist erforderlich: Setzen Sie `code` für den Codefluss auf `true` . Setzen Sie `idToken` für den ID-Token-Fluss auf `true` .
OIDCAuthProviderConfig	Die [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Auth-Provider-Konfigurationsschnittstelle. Ein OIDC-Anbieter kann über BaseAuth.createProviderConfig() erstellt werden. .
OIDCUpdateAuthProviderRequest	Die Anforderungsschnittstelle zum Aktualisieren eines OIDC-Authentifizierungsanbieters. Dies wird verwendet, wenn die Konfiguration eines OIDC-Anbieters über BaseAuth.updateProviderConfig() aktualisiert wird. .
PasswordPolicyConfig	Eine Kennwortrichtlinienkonfiguration für ein Projekt oder einen Mandanten
PhoneIdentifier	Wird zum Suchen eines Kontos anhand der Telefonnummer verwendet. Siehe BaseAuth.getUsers() .
ProviderIdentifier	Wird für die Suche nach einem Konto eines Verbundanbieters verwendet. Siehe BaseAuth.getUsers() .
RecaptchaConfig	Die Anforderungsschnittstelle zum Aktualisieren einer reCAPTCHA-Konfiguration. Durch die Aktivierung der reCAPTCHA Enterprise-Integration stimmen Sie den Nutzungsbedingungen von reCAPTCHA Enterprise zu .
RecaptchaKey	Die reCAPTCHA-Schlüsselkonfiguration.
RecaptchaManagedRule	Die Konfiguration für eine reCAPTCHA-Aktionsregel.
SAMLAuthProviderConfig	Die [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) Auth-Provider-Konfigurationsschnittstelle. Ein SAML-Anbieter kann über BaseAuth.createProviderConfig() erstellt werden .
SAMLUpdateAuthProviderRequest	Die Anforderungsschnittstelle zum Aktualisieren eines SAML-Authentifizierungsanbieters. Dies wird verwendet, wenn die Konfiguration eines SAML-Anbieters über BaseAuth.updateProviderConfig() aktualisiert wird. .
SessionCookieOptions	Schnittstelle, die die Sitzungscookie-Optionen darstellt, die für die BaseAuth.createSessionCookie()- Methode benötigt werden.
TotpMultiFactorProviderConfig	Schnittstelle, die Konfigurationseinstellungen für die TOTP-Authentifizierung mit zweitem Faktor darstellt.
UidIdentifier	Wird zum Suchen eines Kontos anhand der UID verwendet. Siehe BaseAuth.getUsers() .
UpdatePhoneMultiFactorInfoRequest	Schnittstelle, die einen telefonspezifischen, vom Benutzer registrierten zweiten Faktor für eine `UpdateRequest` darstellt.
UpdateProjectConfigRequest	Schnittstelle, die die Eigenschaften darstellt, die in der bereitgestellten Projektkonfiguration aktualisiert werden sollen.
UpdateRequest	Schnittstelle, die die Eigenschaften darstellt, die für den bereitgestellten Benutzer aktualisiert werden sollen.
UpdateTenantRequest	Schnittstelle, die die Eigenschaften darstellt, die auf dem bereitgestellten Mandanten aktualisiert werden sollen.
UserImportOptions	Schnittstelle, die die Benutzerimportoptionen darstellt, die für die BaseAuth.importUsers()- Methode benötigt werden. Dies wird verwendet, um Informationen zum Passwort-Hashing-Algorithmus bereitzustellen.
UserImportRecord	Schnittstelle, die einen Benutzer darstellt, der über die Methode BaseAuth.importUsers() in Firebase Auth importiert werden soll.
UserImportResult	Schnittstelle, die die Antwort der BaseAuth.importUsers()- Methode für den Batch-Import von Benutzern in Firebase Auth darstellt.
UserMetadataRequest	Benutzermetadaten, die beim Importieren eines Benutzers einbezogen werden sollen.
UserProvider	Stellt einen Benutzeridentitätsanbieter dar, der einem Firebase-Benutzer zugeordnet werden kann.
UserProviderRequest	Benutzeranbieterdaten, die beim Importieren eines Benutzers einbezogen werden sollen.

Geben Sie Aliase ein

Geben Sie Alias ein	Beschreibung
AuthFactorType	Identifiziert einen zweiten Faktortyp.
AuthProviderConfig	Der Konfigurationstyp des Authentifizierungsanbieters. BaseAuth.createProviderConfig() .
CreateMultiFactorInfoRequest	Typ, der die Eigenschaften eines vom Benutzer registrierten zweiten Faktors für eine `CreateRequest` darstellt.
CreateTenantRequest	Schnittstelle, die die Eigenschaften darstellt, die für einen neuen Mandanten festgelegt werden sollen.
HashAlgorithmType
MultiFactorConfigState	Identifiziert einen Multifaktor-Konfigurationsstatus.
PasswordPolicyEnforcementState	Der Durchsetzungsstatus einer Passwortrichtlinie.
RecaptchaAction	Die für reCAPTCHA-geschützte Anfragen zu ergreifenden Aktionen. - „BLOCK“: Die reCAPTCHA-geschützte Anfrage wird blockiert.
RecaptchaKeyClientType	Der Plattformtyp des Schlüssels.
RecaptchaProviderEnforcementState	Durchsetzungsstatus des reCAPTCHA-Schutzes. - „AUS“: Nicht erzwungen. - „AUDIT“: Bewertung erstellen, aber das Ergebnis nicht erzwingen. - „ENFORCE“: Bewertung erstellen und das Ergebnis erzwingen.
SMSRegionConfig	Die Anforderungsschnittstelle zum Aktualisieren einer SMS-Regionskonfiguration. Konfiguriert die Regionen, in denen Benutzer Bestätigungs-SMS senden dürfen. Dies basiert auf der Rufvorwahl der Zielrufnummer.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	Typ, der die Eigenschaften eines vom Benutzer registrierten zweiten Faktors für eine `UpdateRequest` darstellt.
Benutzeridentifikator	Identifiziert einen Benutzer, der gesucht werden soll.

getAuth()

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

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

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
App	App

Kehrt zurück:

Auth

Beispiel 1

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

Beispiel 2

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

AuthFactorType

Identifiziert einen zweiten Faktortyp.

Unterschrift:

export type AuthFactorType = 'phone';

AuthProviderConfig

Der Konfigurationstyp des Authentifizierungsanbieters. BaseAuth.createProviderConfig() .

Unterschrift:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

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

Unterschrift:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

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

Unterschrift:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

Unterschrift:

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

MultiFactorConfigState

Identifiziert einen Multifaktor-Konfigurationsstatus.

Unterschrift:

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

PasswordPolicyEnforcementState

Der Durchsetzungsstatus einer Passwortrichtlinie.

Unterschrift:

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

RecaptchaAction

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

Unterschrift:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Der Plattformtyp des Schlüssels.

Unterschrift:

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

RecaptchaProviderEnforcementState

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

Unterschrift:

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

SMSRegionConfig

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

Unterschrift:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Unterschrift:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

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

Unterschrift:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Benutzeridentifikator

Identifiziert einen Benutzer, der gesucht werden soll.

Unterschrift:

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