Nutzer programmatisch verwalten
In diesem Dokument wird gezeigt, wie Sie mit dem Identity Platform Admin SDK Ihre Nutzer programmatisch verwalten. Mit dem Admin SDK können Sie eine Vielzahl gängiger Verwaltungsaufgaben ausführen, z. B. Nutzer erstellen, suchen und ändern.
Hinweis
Installieren Sie das Admin SDK.
Nutzer abrufen
Nutzer nach ID abrufen
Nutzer werden hauptsächlich anhand ihrer uid
identifiziert:
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); });
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)
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}");
Nutzer per E-Mail abrufen
Sie können auch einen Nutzer über dessen E-Mail-Adresse abrufen:
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); });
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)
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}");
Beachten Sie, dass Sie nur mit primären E-Mails und nicht mit anbieterspezifischen E-Mails suchen können. Wenn beispielsweise ein Facebook-Konto mit der E-Mail-Adresse facebookUser@example.com
mit einem vorhandenen Nutzer mit der E-Mail user@example.com
verknüpft ist, führt der Aufruf von getUserByEmail("facebookUser@example.com")
zu keinem Ergebnis. Der Aufruf von getUserByEmail("user@example.com")
gibt den erwarteten Nutzer zurück.
Die primäre E-Mail-Adresse ist von den Einstellungen für die Kontoverknüpfung abhängig:
- Konten verknüpfen, die dieselbe E-Mail-Adresse verwenden: Die primäre E-Mail-Adresse ist die erste E-Mail-Adresse, mit der Sie sich anmelden, sofern nicht manuell aktualisiert.
- Mehrere Konten für jeden Identitätsanbieter erstellen: Die primäre E-Mail-Adresse wird nur festgelegt, wenn ein Passwortnutzer erstellt wird, sofern nicht manuell aktualisiert.
Nutzer nach Telefonnummer abrufen
So suchen Sie nach einem Nutzer 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); });
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)
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}");
Nutzerdaten gesammelt abrufen
Sie können auch eine Liste mit Nutzern anhand der von Ihnen bereitgestellten Kennzeichnungen abrufen. Sie können Nutzer anhand ihrer UID, E-Mail-Adresse oder Telefonnummer identifizieren. In einem einzelnen Aufruf können maximal 100 Kennungen bereitgestellt werden. Kennungen können eine Kombination aus Typen enthalten:
Node.js
getAuth() .getUsers([ { uid: 'uid1' }, { email: 'user2@example.com' }, { phoneNumber: '+15555550003' }, { 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); });
Java
GetUsersResult result = FirebaseAuth.getInstance().getUsersAsync(Arrays.asList( new UidIdentifier("uid1"), new EmailIdentifier("user2@example.com"), new PhoneIdentifier("+15555550003"), 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('user2@example.com'), auth.PhoneIdentifier(+15555550003), 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: "user@example.com"}, auth.PhoneIdentifier{PhoneNumber: "+15555551234"}, 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("user2@example.com"), new PhoneIdentifier("+15555550003"), 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.
Nutzer auflisten
Der folgende Code zeigt, wie Sie alle Nutzer auflisten können:
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();
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 } }
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}"); }
Die Nutzer werden in Batches nach uid
sortiert. Jeder Batch von Ergebnissen enthält eine Liste von Nutzern sowie ein Token für die nächste Seite zum Abrufen des nächsten Batches.
Wenn alle Nutzer aufgelistet wurden, wird kein pageToken
zurückgegeben.
Das Feld maxResult
gibt die maximale Stapelgröße an. Der Standard- und der Höchstwert sind 1.000.
Nutzerpasswort-Hashes auflisten
Da Passwort-Hash-Werte vertraulich sind, gibt das Admin SDK sie nur zurück, wenn der Nutzer die Berechtigung firebaseauth.configs.getHashConfig
hat. Diese Berechtigung wird durch keine vordefinierte Rolle gewährt. So weisen Sie die Berechtigung zu:
Erstellen Sie eine benutzerdefinierte Rolle mit der Berechtigung
firebaseauth.configs.getHashConfig
.Weisen Sie dem Nutzer oder Dienstkonto die benutzerdefinierte Rolle zu.
Nachfolgende Aufrufe von listUsers()
durch Nutzer mit dieser benutzerdefinierten Rolle enthalten die Felder passwordHash
und passwordSalt
.
Nutzer erstellen
Wenn Sie neue Nutzer programmatisch erstellen, werden einige Einschränkungen für Endnutzer vermieden. Sie unterliegen keiner Drosselung oder Ratenbegrenzung und können das normale Bestätigungsverfahren für E-Mails und Telefonnummern umgehen.
So erstellen Sie einen neuen Nutzer:
Node.js
getAuth() .createUser({ email: 'user@example.com', emailVerified: false, phoneNumber: '+11234567890', 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); });
Java
CreateRequest request = new CreateRequest() .setEmail("user@example.com") .setEmailVerified(false) .setPassword("secretPassword") .setPhoneNumber("+11234567890") .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='user@example.com', email_verified=False, phone_number='+15555550100', 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("user@example.com"). EmailVerified(false). PhoneNumber("+15555550100"). 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)
C#
UserRecordArgs args = new UserRecordArgs() { Email = "user@example.com", EmailVerified = false, PhoneNumber = "+11234567890", 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}");
Sie können jede der unten aufgeführten Attribute für einen neuen Nutzer festlegen. Alle Attribute sind optional.
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.
|
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 nicht angegeben, ist 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 | 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 .
|
Nutzer aktualisieren
Node.js
getAuth() .updateUser(uid, { email: 'modifiedUser@example.com', phoneNumber: '+11234567890', 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); });
Java
UpdateRequest request = new UpdateRequest(uid) .setEmail("user@example.com") .setPhoneNumber("+11234567890") .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='user@example.com', phone_number='+15555550100', 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("user@example.com"). EmailVerified(true). PhoneNumber("+15555550100"). 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)
C#
UserRecordArgs args = new UserRecordArgs() { Uid = uid, Email = "modifiedUser@example.com", PhoneNumber = "+11234567890", 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 jedes der folgenden Nutzerattribute aktualisieren. Alle Attribute sind optional. Wenn kein Attribut angegeben ist, bleibt ihr Wert unverändert.
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 nicht angegeben, ist 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.
|
Nutzer löschen
Sie können einen Nutzer mit seiner uid
löschen:
Node.js
getAuth() .deleteUser(uid) .then(() => { console.log('Successfully deleted user'); }) .catch((error) => { console.log('Error deleting user:', error); });
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)
C#
await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid); Console.WriteLine("Successfully deleted user.");
Mehrere Nutzer löschen
Sie können auch mehrere Nutzer gleichzeitig löschen:
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.
Nächste Schritte
- Nutzer von einer bestehenden Anwendung zu Identity Platform migrieren
- SAML- und OIDC-Anbieter programmatisch verwalten