Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Firebase Authentication-Trigger

Sie können Funktionen als Reaktion auf das Erstellen und Löschen von Firebase Authentication-Nutzerkonten auslösen. Sie können beispielsweise eine Begrüßungs-E-Mail an einen Nutzer senden, der gerade ein Konto in Ihrer App erstellt hat. Die Beispiele auf dieser Seite basieren auf einem Beispiel, das genau das tut: Begrüßungs- und Abschieds-E-Mails beim Erstellen und Löschen von Konten senden.

Weitere Beispiele für Anwendungsfälle finden Sie unter Was kann ich mit Cloud Functions tun?.

Funktion beim Erstellen eines Nutzers auslösen

Sie können eine Funktion erstellen, die ausgelöst wird, wenn ein Authentication-Nutzer erstellt wird. Verwenden Sie dazu den Event-Handler onUserCreated aus dem Unterpaket firebase-functions/v2/identity:

const { onUserCreated } = require("firebase-functions/identity");
const { defineSecret } = require("firebase-functions/params");
const { logger } = require("firebase-functions");
const { sendWelcomeEmail } = require("./utils/myEmailService");

const emailApiKey = defineSecret("EMAIL_API_KEY");

exports.newUserWelcome = onUserCreated(
  { secrets: [emailApiKey] },
  async (event) => {
    const { uid, email, displayName } = event.data;

    if (!email) {
      logger.log(`User ${uid} does not have an email address.`);
      return;
    }

    await sendWelcomeEmail(email, displayName);
  },
);newUserWelcome.js

Authentication-Konten lösen in den folgenden Fällen Nutzererstellungsereignisse für Cloud Functions-Funktionen aus:

Ein Nutzer erstellt ein E-Mail-Konto und ein Passwort
Ein Nutzer meldet sich zum ersten Mal über einen Anbieter föderierter Identitäten an.
Der Entwickler erstellt mithilfe des Admin SDK ein Konto.
Ein Nutzer meldet sich zum ersten Mal bei einer neuen anonymen Authentifizierungssitzung an.

Ein Cloud Functions-Ereignis wird nicht ausgelöst, wenn sich ein Nutzer zum ersten Mal über ein benutzerdefiniertes Token anmeldet.

Triggeroptionen und Mehrmandantenfähigkeit konfigurieren

Sie können Ihre Funktion konfigurieren, indem Sie ein Optionsobjekt (AuthOptions) als ersten Parameter an onUserCreated übergeben:

/**
 * Sends a welcome email scoped to a specific tenant in Identity Platform.
 */
exports.sendWelcomeEmailToTenant = onUserCreated(
  {
    secrets: [emailApiKey],
    // Only trigger when a user is a member of this tenant
    tenantId: "my-tenant-id",
  },
  async (event) => {
    const { uid, email, displayName } = event.data;
    // Customize the email for this tenant
    await sendWelcomeEmail(email, displayName, event.tenantId);
  },
);
  /**
 * Sends a welcome email only to users not associated with any tenant.
 */
exports.sendWelcomeEmailNoTenant = onUserCreated(
  {
    secrets: [emailApiKey],
    // Only trigger when a user is NOT a member of a tenant
    tenantId: IS_NOT_TENANT,
  },
  async (event) => {
    const { email, displayName } = event.data;

    // Send a generic welcome email
    await sendWelcomeEmail(email, displayName);
  },
);tenants.js

Wenn Ihr Projekt die Mehrmandantenfähigkeit von Identity Platform verwendet, können Sie den Trigger einschränken:

Standardprojekt (kein Mandant): Setzen Sie tenantId auf IS_NOT_TENANT, um nur auf Nutzer zu warten, die im Standardprojekt erstellt wurden.
Bestimmter Mandant: Geben Sie die String-ID des Mandanten an (z. B. { tenantId: "tenant-id-1" }), um nur auf Nutzer zu warten, die in diesem Mandanten erstellt wurden.
Alle Mandanten und Nutzer: Wenn tenantId weggelassen wird, wird die Funktion bei Ereignissen zur Nutzererstellung für alle Mandanten und Standardprojekt-Nutzer im Projekt ausgelöst.

Zusätzlich zu tenantId können Sie Standardkonfigurationsoptionen der 2. Generation angeben, darunter region, concurrency, cpu, memory, timeoutSeconds, minInstances, maxInstances und secrets.

Auf Nutzerattribute zugreifen

Über die Nutzerdaten, die an Ihre Funktion zurückgegeben werden, können Sie über event.data auf die Liste der Nutzerattribute zugreifen, die im UserRecord-Objekt des neu erstellten Nutzers verfügbar sind. So können Sie beispielsweise die E-Mail-Adresse und den Anzeigenamen des Nutzers abrufen:

const { uid, email, displayName } = event.data;newUserWelcome.js

Authentifizierungstrigger der 2. Generation erhalten ein AuthEvent-Objekt. Zusätzlich zu event.data können Sie auf Ereignismetadaten wie die folgenden zugreifen:

event.id: Eine eindeutige Kennung für das Ereignis.
event.type: Der Ereignistyp (google.firebase.auth.user.v2.created).
event.time: Ein ISO 8601-Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
event.project: die Google Cloud-Projekt-ID.
event.tenantId: Die Identity Platform-Mandanten-ID, die dem Nutzer zugeordnet ist, falls zutreffend.

Funktion beim Löschen eines Nutzers auslösen

Genauso wie Sie eine Funktion beim Erstellen eines Nutzers auslösen können, können Sie auch auf Ereignisse zum Löschen von Nutzern reagieren. Verwenden Sie den Event-Handler onUserDeleted aus firebase-functions/v2/identity wie hier gezeigt:

const { onUserDeleted } = require("firebase-functions/identity");
const { defineSecret } = require("firebase-functions/params");
const { logger } = require("firebase-functions");
const { sendGoodbyeEmail } = require("./utils/myEmailService");

const emailApiKey = defineSecret("EMAIL_API_KEY");

exports.deletedUserFarewell = onUserDeleted(
  { secrets: [emailApiKey] },
  async (event) => {
    const { uid, email, displayName } = event.data;
    if (!email) {
      logger.log(`User ${uid} does not have an email address.`);
      return;
    }

    await sendGoodbyeEmail(email, displayName);
  },
);deletedUserFarewell.js

Wie bei onUserCreated können Sie onUserDeleted mit Optionen wie { tenantId: IS_NOT_TENANT } konfigurieren, um Trigger auf Nutzer im Standardprojekt zu beschränken.

Blockierfunktionen auslösen

Wenn Sie ein Upgrade auf Firebase Authentication with Identity Platform durchgeführt haben, können Sie Firebase Authentication mit Blockierfunktionen erweitern.

Mit Blockierfunktionen können Sie benutzerdefinierten Code synchron ausführen, der das Ergebnis einer Nutzerregistrierung oder Anmeldung bei Ihrer App ändert. Im Gegensatz zu Hintergrund-Triggern, die asynchron nach Abschluss eines Ereignisses ausgeführt werden, können Sie mit Blockierfunktionen verhindern, dass sich ein Nutzer authentifiziert, wenn er bestimmte Kriterien nicht erfüllt, oder die Informationen und Anforderungen eines Nutzers aktualisieren, bevor sie an Ihre Client-App zurückgegeben werden.

Best Practices für Trigger der 2. Generation

Beachten Sie bei der Implementierung von Authentifizierungstriggern der 2. Generation die folgenden Best Practices:

Nebenläufigkeit berücksichtigen: Cloud Functions-Instanzen (2. Generation) verarbeiten gleichzeitige Anfragen (standardmäßig 80 gleichzeitige Anfragen, wenn die CPU ≥ 1 ist). Achten Sie darauf, dass Ihre Funktion nicht auf globalen veränderlichen Zuständen zwischen gleichzeitigen Ausführungen basiert.
Auf Idempotenz auslegen: Die Ereignisbereitstellung in der 2. Generation erfolgt mindestens einmal über Eventarc. Achten Sie darauf, dass Ihre Funktionen idempotent sind. Prüfen Sie beispielsweise, ob eine Willkommens-E-Mail nicht bereits gesendet oder ein Datenbankeintrag initialisiert wurde, bevor Sie Nebenwirkungen ausführen.
Bereich für mandantenfähige Funktionen festlegen: Wenn Ihre Anwendung die Mandantenfähigkeit von Identity Platform verwendet, prüfen Sie, ob Ihre Funktionen Ereignisse für alle Mandanten oder nur für bestimmte Mandanten verarbeiten sollen. Verwenden Sie tenantId: IS_NOT_TENANT, um zu verhindern, dass Mandantennutzer Funktionen auslösen, die nur für das primäre Projekt vorgesehen sind.
Regionen und Ressourcenzuweisung verwalten: Geben Sie den Funktionsstandort (region) an, um die Netzwerklatenz zwischen Ihrem Authentifizierungsanbieter und Ihrer Funktionsausführungsumgebung zu minimieren.