Nutzer verwalten

Das Firebase Admin SDK bietet eine API zum Verwalten Ihrer Firebase Authentication-Nutzer mit erhöhten Berechtigungen. Mit der API zur Verwaltung von Administratornutzern können Sie die folgenden Aufgaben programmatisch aus einer sicheren Serverumgebung ausführen:

• Neue Nutzer ohne Drosselung oder Ratenbegrenzung erstellen.
• Nutzer anhand verschiedener Kriterien wie UID, E-Mail-Adresse oder Telefonnummer suchen
• Alle Nutzer eines bestimmten Projekts in Stapeln auflisten.
• Zugriff auf Nutzermetadaten, einschließlich Erstellungsdatum des Kontos und Datum der letzten Anmeldung.
• Nutzer löschen, ohne dass ihr vorhandenes Passwort erforderlich ist
• Nutzereigenschaften, einschließlich des Passworts, aktualisieren, ohne sich als Nutzer anmelden zu müssen
• E-Mails bestätigen, ohne die Out-of-Band-Aktionsabläufe zur Bestätigung von E-Mails durchlaufen zu müssen
• E-Mail-Adresse eines Nutzers ändern, ohne E-Mail-Links zum Widerrufen dieser Änderungen zu senden
• Sie können einen neuen Nutzer mit einer Telefonnummer erstellen, ohne den SMS-Bestätigungsvorgang durchlaufen zu müssen.
• Die Telefonnummer eines Nutzers ändern, ohne die SMS-Bestätigung durchlaufen zu müssen.
• Sie können Nutzer offline in einem deaktivierten Zustand bereitstellen und dann später festlegen, wann sie aktiviert werden sollen.
• Benutzerdefinierte Nutzerkonsolen erstellen, die auf das Nutzerverwaltungssystem einer bestimmten Anwendung zugeschnitten sind

Hinweis

Wenn Sie die vom Firebase Admin SDK bereitgestellte API zur Nutzerverwaltung verwenden möchten, benötigen Sie ein Dienstkonto. Weitere Informationen zum Initialisieren des Admin SDK finden Sie in der Einrichtungsanleitung.

Nutzerdaten abrufen

Nutzer werden hauptsächlich anhand ihrer uid identifiziert, einer eindeutigen Kennung für diesen Nutzer. Das Admin SDK bietet eine Methode, mit der die Profilinformationen von Nutzern anhand ihrer uid abgerufen werden können:

Node.js

getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUser(uid);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getUid());

Python

from firebase_admin import auth

user = auth.get_user(uid)
print('Successfully fetched user data: {0}'.format(user.uid))

Go

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

u, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatalf("error getting user %s: %v\n", uid, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

Diese Methode gibt ein UserRecord-Objekt für den Nutzer zurück, das dem uid entspricht, das der Methode übergeben wurde.

Wenn die angegebene uid nicht zu einem vorhandenen Nutzer gehört oder der Nutzer aus einem anderen Grund nicht abgerufen werden kann, wird bei der oben genannten Methode ein Fehler ausgegeben. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Auth API-Fehler.

In einigen Fällen haben Sie die E-Mail-Adresse eines Nutzers anstelle seiner uid. Das Firebase Admin SDK unterstützt das Abrufen von Nutzerinformationen mit einer E-Mail-Adresse:

Node.js

getAuth()
  .getUserByEmail(email)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUserByEmail(email);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getEmail());

Python

from firebase_admin import auth

user = auth.get_user_by_email(email)
print('Successfully fetched user data: {0}'.format(user.uid))

Go

u, err := client.GetUserByEmail(ctx, email)
if err != nil {
	log.Fatalf("error getting user by email %s: %v\n", email, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

Diese Methode gibt ein UserRecord-Objekt für den Nutzer zurück, das der angegebenen E-Mail-Adresse entspricht.

Wenn die angegebene E-Mail-Adresse nicht zu einem vorhandenen Nutzer gehört oder der Nutzer aus einem anderen Grund nicht abgerufen werden kann, gibt das Admin SDK einen Fehler zurück. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Warnung :Bei der E-Mail-Suche können Sie nur nach der Haupt-E-Mail-Adresse (Top-Level-E-Mail-Adresse) und nicht nach anbieterspezifischen E-Mail-Adressen suchen. Wenn beispielsweise ein Facebook-Konto mit einer anderen E-Mail-Adresse [e-mail] mit einem vorhandenen Nutzer mit der E-Mail-Adresse [e-mail] verknüpft ist, führt der Aufruf von getUserByEmail("[e-mail]") zu keinem Ergebnis. getUserByEmail("[e-mail]") hingegen gibt den erwarteten Nutzer zurück. Bei der Standardeinstellung „Ein Konto pro E-Mail-Adresse“ wird die erste E-Mail-Adresse, mit der Sie sich anmelden, als E-Mail-Adresse der obersten Ebene verwendet, sofern sie nicht später geändert wird. Wenn „Mehrere Konten pro E-Mail-Adresse“ festgelegt ist, wird die Haupt-E-Mail-Adresse nur festgelegt, wenn ein Passwortnutzer erstellt wird, sofern nicht manuell aktualisiert.

In anderen Fällen haben Sie die Telefonnummer eines Nutzers anstelle seiner uid. Das Firebase Admin SDK unterstützt das Abrufen von Nutzerinformationen mit einer Telefonnummer:

Node.js

getAuth()
  .getUserByPhoneNumber(phoneNumber)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data:  ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUserByPhoneNumber(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getPhoneNumber());

Python

from firebase_admin import auth

user = auth.get_user_by_phone_number(phone)
print('Successfully fetched user data: {0}'.format(user.uid))

Go

u, err := client.GetUserByPhoneNumber(ctx, phone)
if err != nil {
	log.Fatalf("error getting user by phone %s: %v\n", phone, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

Diese Methode gibt ein UserRecord-Objekt für den Nutzer zurück, das der angegebenen Telefonnummer entspricht.

Wenn die angegebene Telefonnummer nicht zu einem vorhandenen Nutzer gehört oder der Nutzer aus einem anderen Grund nicht abgerufen werden kann, wirft das Admin SDK einen Fehler. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Nutzerdaten gesammelt abrufen

Mit dem Firebase Admin SDK können Sie auch eine Liste mit Nutzern anhand der von Ihnen bereitgestellten Kennzeichnungen abrufen. Sie können Nutzer anhand ihrer Nutzer-ID, E-Mail-Adresse oder Telefonnummer identifizieren. In einem einzelnen Aufruf können maximal 100 IDs bereitgestellt werden. Kennungen können eine Kombination aus Typen enthalten:

Node.js

getAuth()
  .getUsers([
    { uid: 'uid1' },
    { email: '[e-mail]' },
    { phoneNumber: '[phone]' },
    { providerId: 'google.com', providerUid: 'google_uid4' },
  ])
  .then((getUsersResult) => {
    console.log('Successfully fetched user data:');
    getUsersResult.users.forEach((userRecord) => {
      console.log(userRecord);
    });

    console.log('Unable to find users corresponding to these identifiers:');
    getUsersResult.notFound.forEach((userIdentifier) => {
      console.log(userIdentifier);
    });
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

GetUsersResult result = FirebaseAuth.getInstance().getUsersAsync(Arrays.asList(
    new UidIdentifier("uid1"),
    new EmailIdentifier("[e-mail]"),
    new PhoneIdentifier("[phone]"),
    new ProviderIdentifier("google.com", "google_uid4"))).get();

System.out.println("Successfully fetched user data:");
for (UserRecord user : result.getUsers()) {
  System.out.println(user.getUid());
}

System.out.println("Unable to find users corresponding to these identifiers:");
for (UserIdentifier uid : result.getNotFound()) {
  System.out.println(uid);
}

Python

from firebase_admin import auth

result = auth.get_users([
    auth.UidIdentifier('uid1'),
    auth.EmailIdentifier('[e-mail]'),
    auth.PhoneIdentifier([phone]),
    auth.ProviderIdentifier('google.com', 'google_uid4')
])

print('Successfully fetched user data:')
for user in result.users:
    print(user.uid)

print('Unable to find users corresponding to these identifiers:')
for uid in result.not_found:
    print(uid)

Go

getUsersResult, err := client.GetUsers(ctx, []auth.UserIdentifier{
	auth.UIDIdentifier{UID: "uid1"},
	auth.EmailIdentifier{Email: "[e-mail]"},
	auth.PhoneIdentifier{PhoneNumber: "[phone]"},
	auth.ProviderIdentifier{ProviderID: "google.com", ProviderUID: "google_uid1"},
})
if err != nil {
	log.Fatalf("error retriving multiple users: %v\n", err)
}

log.Printf("Successfully fetched user data:")
for _, u := range getUsersResult.Users {
	log.Printf("%v", u)
}

log.Printf("Unable to find users corresponding to these identifiers:")
for _, id := range getUsersResult.NotFound {
	log.Printf("%v", id)
}

C#

GetUsersResult result = await FirebaseAuth.DefaultInstance.GetUsersAsync(
    new List<UserIdentifier>
    {
        new UidIdentifier("uid1"),
        new EmailIdentifier("[e-mail]"),
        new PhoneIdentifier("[phone]"),
        new ProviderIdentifier("google.com", "google_uid4"),
    });

Console.WriteLine("Successfully fetched user data:");
foreach (UserRecord user in result.Users)
{
    Console.WriteLine($"User: {user.Uid}");
}

Console.WriteLine("Unable to find users corresponding to these identifiers:");
foreach (UserIdentifier uid in result.NotFound)
{
    Console.WriteLine($"{uid}");
}

Diese Methode gibt eine Liste zurück, die die gleiche Größe wie die Eingabeliste hat. Jeder Eintrag enthält entweder den entsprechenden UserRecord oder einen Fehler, der angibt, warum diese ID nicht nachgeschlagen werden konnte. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Nutzer erstellen

Das Admin SDK bietet eine Methode, mit der Sie einen neuen Firebase Authentication-Nutzer erstellen können. Diese Methode akzeptiert ein Objekt mit den Profilinformationen, die in das neu erstellte Nutzerkonto aufgenommen werden sollen:

Node.js

getAuth()
  .createUser({
    email: '[e-mail]',
    emailVerified: false,
    phoneNumber: '[phone]',
    password: 'secretPassword',
    displayName: 'John Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: false,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });
manage_users.js

Java

CreateRequest request = new CreateRequest()
    .setEmail("[e-mail]")
    .setEmailVerified(false)
    .setPassword("secretPassword")
    .setPhoneNumber("[phone]")
    .setDisplayName("John Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(false);

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

Python

user = auth.create_user(
    email='[e-mail]',
    email_verified=False,
    phone_number='[phone]',
    password='secretPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=False)
print('Sucessfully created new user: {0}'.format(user.uid))

Go

params := (&auth.UserToCreate{}).
	Email("[e-mail]").
	EmailVerified(false).
	PhoneNumber("[phone]").
	Password("secretPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(false)
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)
auth.go

C#

UserRecordArgs args = new UserRecordArgs()
{
    Email = "[e-mail]",
    EmailVerified = false,
    PhoneNumber = "[phone]",
    Password = "secretPassword",
    DisplayName = "John Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = false,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

Standardmäßig generiert Firebase Authentication ein zufälliges uid für den neuen Nutzer. Wenn Sie stattdessen eine eigene uid für den neuen Nutzer angeben möchten, können Sie sie als Argument an die Methode zum Erstellen von Nutzern übergeben:

Node.js

getAuth()
  .createUser({
    uid: 'some-uid',
    email: '[e-mail]',
    phoneNumber: '[phone]',
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });
manage_users.js

Java

CreateRequest request = new CreateRequest()
    .setUid("some-uid")
    .setEmail("[e-mail]")
    .setPhoneNumber("[phone]");

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

Python

user = auth.create_user(
    uid='some-uid', email='[e-mail]', phone_number='[phone]')
print('Sucessfully created new user: {0}'.format(user.uid))

Go

params := (&auth.UserToCreate{}).
	UID(uid).
	Email("[e-mail]").
	PhoneNumber("[phone]")
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)
auth.go

C#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = "some-uid",
    Email = "[e-mail]",
    PhoneNumber = "[phone]",
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

Sie können eine beliebige Kombination der folgenden Properties angeben:

Tabelle 1. Vom Vorgang „create user“ unterstützte Eigenschaften

Attribut	Typ	Beschreibung
uid	String	Die uid, die dem neu erstellten Nutzer zugewiesen werden soll. Muss ein String zwischen 1 und 128 Zeichen lang sein. Wenn nicht angegeben, wird automatisch ein zufälliger uid generiert. Je kürzer die uid, desto besser die Leistung.
email	String	Primäre E-Mail-Adresse des Nutzers. Geben Sie eine gültige E-Mail-Adresse ein.
emailVerified	boolean	Gibt an, ob die primäre E-Mail-Adresse des Nutzers bestätigt ist oder nicht. Wenn keine Angabe erfolgt, lautet der Standardwert false.
phoneNumber	String	Primäre Telefonnummer des Nutzers. Muss eine gültige E.164-konforme Telefonnummer sein.
password	String	Das unverschlüsselte Passwort des Nutzers. Muss mindestens sechs Zeichen lang sein.
displayName	String	Anzeigename des Nutzers.
photoURL	String	Die Foto-URL des Nutzers.
disabled	boolean	Aktivierungsstatus des Nutzers. true für deaktiviert; false für aktiviert. Wenn keine Angabe gemacht wird, lautet der Standardwert false.

Hinweis: Alle oben genannten Properties sind optional. Wenn eine bestimmte Property nicht angegeben ist, ist der Wert für diese Property leer, es sei denn, in der obigen Tabelle ist ein Standardwert angegeben.

Die Methode zum Erstellen von Nutzern gibt ein UserRecord-Objekt für den neu erstellten Nutzer zurück.

Wenn die angegebene uid, E-Mail-Adresse oder Telefonnummer bereits von einem anderen Nutzer verwendet wird oder der Nutzer aus einem anderen Grund nicht erstellt werden kann, schlägt die oben beschriebene Methode fehl. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Nutzer aktualisieren

Mit dem Firebase Admin SDK können Sie die Daten eines vorhandenen Nutzers ändern. Sie müssen einen uid und die Attribute angeben, die für diesen Nutzer aktualisiert werden sollen:

Node.js

getAuth()
  .updateUser(uid, {
    email: '[e-mail]',
    phoneNumber: '[phone]',
    emailVerified: true,
    password: 'newPassword',
    displayName: 'Jane Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: true,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully updated user', userRecord.toJSON());
  })
  .catch((error) => {
    console.log('Error updating user:', error);
  });
manage_users.js

Java

UpdateRequest request = new UpdateRequest(uid)
    .setEmail("[e-mail]")
    .setPhoneNumber("[phone]")
    .setEmailVerified(true)
    .setPassword("newPassword")
    .setDisplayName("Jane Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(true);

UserRecord userRecord = FirebaseAuth.getInstance().updateUser(request);
System.out.println("Successfully updated user: " + userRecord.getUid());

Python

user = auth.update_user(
    uid,
    email='[e-mail]',
    phone_number='[phone]',
    email_verified=True,
    password='newPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=True)
print('Sucessfully updated user: {0}'.format(user.uid))

Go

params := (&auth.UserToUpdate{}).
	Email("[e-mail]").
	EmailVerified(true).
	PhoneNumber("[phone]").
	Password("newPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(true)
u, err := client.UpdateUser(ctx, uid, params)
if err != nil {
	log.Fatalf("error updating user: %v\n", err)
}
log.Printf("Successfully updated user: %v\n", u)
auth.go

C#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = uid,
    Email = "[e-mail]",
    PhoneNumber = "[phone]",
    EmailVerified = true,
    Password = "newPassword",
    DisplayName = "Jane Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = true,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.UpdateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully updated user: {userRecord.Uid}");

Sie können eine beliebige Kombination der folgenden Properties angeben:

Tabelle 2. Vom Vorgang „Nutzer aktualisieren“ unterstützte Properties

Attribut	Typ	Beschreibung
email	String	Neue primäre E-Mail-Adresse des Nutzers. Geben Sie eine gültige E-Mail-Adresse ein.
emailVerified	boolean	Gibt an, ob die primäre E-Mail-Adresse des Nutzers bestätigt ist oder nicht. Wenn keine Angabe erfolgt, lautet der Standardwert false.
phoneNumber	String	Die neue primäre Telefonnummer des Nutzers. Muss eine gültige E.164-konforme Telefonnummer sein. Legen Sie null fest, um die vorhandene Telefonnummer des Nutzers zu löschen.
password	String	Das neue unverschlüsselte Passwort des Nutzers. Muss mindestens sechs Zeichen lang sein.
displayName	String | null	Der neue Anzeigename der Nutzer Legen Sie null fest, um den vorhandenen Anzeigenamen des Nutzers zu löschen.
photoURL	String | null	Die neue Foto-URL des Nutzers. Mit null wird die vorhandene Foto-URL des Nutzers gelöscht. Wenn der Wert nicht null ist, muss es sich um eine gültige URL handeln.
disabled	boolean	Aktivierungsstatus des Nutzers. true für deaktiviert; false für aktiviert.

Hinweis: Alle oben genannten Properties sind optional. Wenn eine bestimmte Property nicht angegeben ist, bleibt der vorhandene Wert für diese Property unverändert.

Die Methode „update user“ gibt ein aktualisiertes UserRecord-Objekt zurück, wenn das Update erfolgreich abgeschlossen wurde.

Wenn die angegebene uid keinem vorhandenen Nutzer entspricht, die angegebene E-Mail-Adresse oder Telefonnummer bereits von einem anderen Nutzer verwendet wird oder der Nutzer aus einem anderen Grund nicht aktualisiert werden kann, schlägt die oben genannte Methode fehl und es wird eine Fehlermeldung angezeigt. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Nutzer löschen

Mit dem Firebase Admin SDK können Sie vorhandene Nutzer anhand der folgenden Informationen löschen: uid

Node.js

getAuth()
  .deleteUser(uid)
  .then(() => {
    console.log('Successfully deleted user');
  })
  .catch((error) => {
    console.log('Error deleting user:', error);
  });
manage_users.js

Java

FirebaseAuth.getInstance().deleteUser(uid);
System.out.println("Successfully deleted user.");

Python

auth.delete_user(uid)
print('Successfully deleted user')

Go

err := client.DeleteUser(ctx, uid)
if err != nil {
	log.Fatalf("error deleting user: %v\n", err)
}
log.Printf("Successfully deleted user: %s\n", uid)
auth.go

C#

await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid);
Console.WriteLine("Successfully deleted user.");

Die Methode „delete user“ gibt ein leeres Ergebnis zurück, wenn der Löschvorgang erfolgreich abgeschlossen ist.

Wenn die angegebene uid nicht zu einem vorhandenen Nutzer gehört oder der Nutzer aus einem anderen Grund nicht gelöscht werden kann, wird von der Methode „delete user“ ein Fehler ausgegeben. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Mehrere Nutzer löschen

Mit dem Firebase Admin SDK können Sie auch mehrere Nutzer gleichzeitig löschen. Wenn Sie jedoch Methoden wie deleteUsers(uids) verwenden, um mehrere Nutzer gleichzeitig zu löschen, werden keine onDelete()-Ereignishandler für Cloud Functions for Firebase ausgelöst. Das liegt daran, dass beim Löschen mehrerer Nutzer nicht für jeden Nutzer ein Löschereignis ausgelöst wird. Löschen Sie Nutzer einzeln, wenn für jeden gelöschten Nutzer ein Ereignis zum Löschen von Nutzern ausgelöst werden soll.

Node.js

getAuth()
  .deleteUsers([uid1, uid2, uid3])
  .then((deleteUsersResult) => {
    console.log(`Successfully deleted ${deleteUsersResult.successCount} users`);
    console.log(`Failed to delete ${deleteUsersResult.failureCount} users`);
    deleteUsersResult.errors.forEach((err) => {
      console.log(err.error.toJSON());
    });
  })
  .catch((error) => {
    console.log('Error deleting users:', error);
  });

Java

DeleteUsersResult result = FirebaseAuth.getInstance().deleteUsersAsync(
    Arrays.asList("uid1", "uid2", "uid3")).get();

System.out.println("Successfully deleted " + result.getSuccessCount() + " users");
System.out.println("Failed to delete " + result.getFailureCount() + " users");
for (ErrorInfo error : result.getErrors()) {
  System.out.println("error #" + error.getIndex() + ", reason: " + error.getReason());
}

Python

from firebase_admin import auth

result = auth.delete_users(["uid1", "uid2", "uid3"])

print('Successfully deleted {0} users'.format(result.success_count))
print('Failed to delete {0} users'.format(result.failure_count))
for err in result.errors:
    print('error #{0}, reason: {1}'.format(result.index, result.reason))

Go

deleteUsersResult, err := client.DeleteUsers(ctx, []string{"uid1", "uid2", "uid3"})
if err != nil {
	log.Fatalf("error deleting users: %v\n", err)
}

log.Printf("Successfully deleted %d users", deleteUsersResult.SuccessCount)
log.Printf("Failed to delete %d users", deleteUsersResult.FailureCount)
for _, err := range deleteUsersResult.Errors {
	log.Printf("%v", err)
}

C#

DeleteUsersResult result = await FirebaseAuth.DefaultInstance.DeleteUsersAsync(new List<string>
    {
        "uid1",
        "uid2",
        "uid3",
    });

Console.WriteLine($"Successfully deleted {result.SuccessCount} users.");
Console.WriteLine($"Failed to delete {result.FailureCount} users.");

foreach (ErrorInfo err in result.Errors)
{
    Console.WriteLine($"Error #{err.Index}, reason: {err.Reason}");
}

Die Methode "delete user" gibt die Liste der Fehler für die Nutzer zurück, die nicht gelöscht werden konnten. Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Alle Nutzer aufführen

Mit dem Firebase Admin SDK können Sie die gesamte Liste der Nutzer in Batches abrufen:

Node.js

const listAllUsers = (nextPageToken) => {
  // List batch of users, 1000 at a time.
  getAuth()
    .listUsers(1000, nextPageToken)
    .then((listUsersResult) => {
      listUsersResult.users.forEach((userRecord) => {
        console.log('user', userRecord.toJSON());
      });
      if (listUsersResult.pageToken) {
        // List next batch of users.
        listAllUsers(listUsersResult.pageToken);
      }
    })
    .catch((error) => {
      console.log('Error listing users:', error);
    });
};
// Start listing users from the beginning, 1000 at a time.
listAllUsers();
manage_users.js

Java

// Start listing users from the beginning, 1000 at a time.
ListUsersPage page = FirebaseAuth.getInstance().listUsers(null);
while (page != null) {
  for (ExportedUserRecord user : page.getValues()) {
    System.out.println("User: " + user.getUid());
  }
  page = page.getNextPage();
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
page = FirebaseAuth.getInstance().listUsers(null);
for (ExportedUserRecord user : page.iterateAll()) {
  System.out.println("User: " + user.getUid());
}

Python

# Start listing users from the beginning, 1000 at a time.
page = auth.list_users()
while page:
    for user in page.users:
        print('User: ' + user.uid)
    # Get next batch of users.
    page = page.get_next_page()

# Iterate through all users. This will still retrieve users in batches,
# buffering no more than 1000 users in memory at a time.
for user in auth.list_users().iterate_all():
    print('User: ' + user.uid)

Go

// Note, behind the scenes, the Users() iterator will retrive 1000 Users at a time through the API
iter := client.Users(ctx, "")
for {
	user, err := iter.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		log.Fatalf("error listing users: %s\n", err)
	}
	log.Printf("read user user: %v\n", user)
}

// Iterating by pages 100 users at a time.
// Note that using both the Next() function on an iterator and the NextPage()
// on a Pager wrapping that same iterator will result in an error.
pager := iterator.NewPager(client.Users(ctx, ""), 100, "")
for {
	var users []*auth.ExportedUserRecord
	nextPageToken, err := pager.NextPage(&users)
	if err != nil {
		log.Fatalf("paging error %v\n", err)
	}
	for _, u := range users {
		log.Printf("read user user: %v\n", u)
	}
	if nextPageToken == "" {
		break
	}
}
auth.go

C#

// Start listing users from the beginning, 1000 at a time.
var pagedEnumerable = FirebaseAuth.DefaultInstance.ListUsersAsync(null);
var responses = pagedEnumerable.AsRawResponses().GetAsyncEnumerator();
while (await responses.MoveNextAsync())
{
    ExportedUserRecords response = responses.Current;
    foreach (ExportedUserRecord user in response.Users)
    {
        Console.WriteLine($"User: {user.Uid}");
    }
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
var enumerator = FirebaseAuth.DefaultInstance.ListUsersAsync(null).GetAsyncEnumerator();
while (await enumerator.MoveNextAsync())
{
    ExportedUserRecord user = enumerator.Current;
    Console.WriteLine($"User: {user.Uid}");
}

Jeder Batch von Ergebnissen enthält eine Liste von Nutzern sowie ein Token für die nächste Seite, um den nächsten Nutzer-Batch aufzulisten. Wenn alle Nutzer bereits aufgelistet sind, wird kein pageToken zurückgegeben.

Wenn kein Feld maxResults angegeben ist, wird der Standardwert von 1.000 Nutzern pro Batch verwendet. Dies ist auch die maximale Anzahl der Nutzer, die gleichzeitig aufgelistet werden können. Jeder Wert, der größer als der Höchstwert ist, löst einen Argumentfehler aus. Wenn kein pageToken angegeben ist, werden die Nutzer nach uid sortiert und von Beginn an aufgelistet.

Eine vollständige Liste der Fehlercodes, einschließlich Beschreibungen und Schritten zur Fehlerbehebung, finden Sie unter Admin Authentication API-Fehler.

Passwort-Hashes der aufgeführten Nutzer

Diese API gibt auch die vom Firebase Auth-Backend gehashten Werte passwordSalt und passwordHash für Nutzer mit Passwort zurück, wenn das Nutzer-/Dienstkonto, das zum Generieren des angeforderten OAuth-Zugriffstokens verwendet wurde, die Berechtigung firebaseauth.configs.getHashConfig hat. Andernfalls werden passwordHash und passwordSalt nicht festgelegt.

Da Passwort-Hash-Werte vertraulich sind, hat das Firebase Admin SDK-Dienstkonto standardmäßig nicht die Berechtigung firebaseauth.configs.getHashConfig. Sie können einer Nutzer- oder Dienstkonto-Berechtigung keine Berechtigung direkt hinzufügen. Sie können dies aber indirekt tun, indem Sie eine benutzerdefinierte IAM-Rolle erstellen.

So erstellen Sie die benutzerdefinierte IAM-Rolle:

1. Rufen Sie in der Google Cloud Console im Bereich IAM & Verwaltung die Seite Rollen auf.
2. Wählen Sie das Projekt oben auf der Seite aus der Drop-down-Liste aus.
3. Klicken Sie auf ROLLE ERSTELLEN.
4. Klicken Sie auf BERECHTIGUNGEN HINZUFÜGEN.
5. Suchen Sie nach der Berechtigung firebaseauth.configs.getHashConfig und klicken Sie das Kästchen an.
6. Klicken Sie auf HINZUFÜGEN.
7. Klicken Sie auf ERSTELLEN, um die neue Rolle zu erstellen.

Fügen Sie die erstellte benutzerdefinierte Rolle dem Nutzer-/Dienstkonto auf der IAM-Seite hinzu:

1. Wählen Sie im Bereich IAM und Verwaltung die Option IAM aus.
2. Wählen Sie in der Liste der Mitglieder das Dienst- oder Nutzerkonto aus, das Sie bearbeiten möchten.
3. Klicken Sie auf WEITERE ROLLE HINZUFÜGEN.
4. Suchen Sie nach der zuvor erstellten neuen benutzerdefinierten Rolle.
5. Klicken Sie auf SPEICHERN.

Warnung: Verwenden Sie die Rolle Editor nicht, um die Berechtigung firebaseauth.configs.getHashConfig hinzuzufügen. Diese Rolle bietet Berechtigungen, die über den beabsichtigten Umfang hinausgehen.