Zarządzanie użytkownikami

Pakiet Firebase Admin SDK udostępnia interfejs API do zarządzania użytkownikami Firebase Authentication z podwyższonymi uprawnieniami. Interfejs API do zarządzania użytkownikami przez administratora umożliwia automatyczne wykonywanie tych zadań w bezpiecznym środowisku serwera:

  • tworzyć nowych użytkowników bez ograniczania liczby żądań.
  • Wyszukuj użytkowników według różnych kryteriów, takich jak identyfikator, adres e-mail czy numer telefonu.
  • Wyświetlanie listy wszystkich użytkowników określonego projektu w partiach.
  • Dostęp do metadanych użytkownika, w tym daty utworzenia konta i daty ostatniego logowania.
  • usuwać użytkowników bez konieczności podawania ich obecnego hasła;
  • aktualizować właściwości użytkownika, w tym jego hasło, bez konieczności logowania się jako ten użytkownik;
  • Weryfikuj adresy e-mail bez konieczności przechodzenia przez procesy działań poza pasmem.
  • Zmień adres e-mail użytkownika bez wysyłania linków e-mail, aby cofnąć te zmiany.
  • Utwórz nowego użytkownika z numerem telefonu bez konieczności przechodzenia przez proces weryfikacji SMS-em.
  • Zmień numer telefonu użytkownika bez konieczności przechodzenia przez proces weryfikacji SMS-em.
  • Możesz udostępniać konta użytkowników offline w stanie wyłączonym, a następnie kontrolować, kiedy je włączyć.
  • Tworzenie niestandardowych konsol użytkowników dostosowanych do systemu zarządzania użytkownikami konkretnej aplikacji.

Zanim zaczniesz

Aby korzystać z interfejsu API zarządzania użytkownikami udostępnianego przez pakiet Firebase Admin SDK, musisz mieć konto usługi. Więcej informacji o inicjowaniu pakietu Admin SDK znajdziesz w instrukcjach konfiguracji.

Pobieranie danych użytkownika

Podstawowym sposobem identyfikacji użytkownika jest jego uid, czyli unikalny identyfikator. Pakiet Admin SDK udostępnia metodę, która umożliwia pobieranie informacji o profilu użytkowników na podstawie ich uid:

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(f'Successfully fetched user data: {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}");

Ta metoda zwraca obiekt UserRecord dla użytkownika odpowiadającego wartości uid podanej w metodzie.

Jeśli podany uid nie należy do istniejącego użytkownika lub nie można pobrać użytkownika z innego powodu, powyższa metoda zgłasza błąd. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin Auth API.

W niektórych przypadkach zamiast identyfikatora uid użytkownika będziesz mieć jego adres e-mail. Pakiet SDK Firebase Admin obsługuje wyszukiwanie informacji o użytkowniku za pomocą adresu e-mail:

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(f'Successfully fetched user data: {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}");

Ta metoda zwraca obiekt UserRecord dla użytkownika odpowiadającego podanemu adresowi e-mail.

Jeśli podany adres e-mail nie należy do istniejącego użytkownika lub nie można pobrać użytkownika z innego powodu, pakiet Admin SDK zgłasza błąd. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Authentication API.

W innych przypadkach zamiast identyfikatora uid będziesz mieć numer telefonu użytkownika. Pakiet Firebase Admin SDK obsługuje wyszukiwanie informacji o użytkowniku za pomocą numeru telefonu:

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(f'Successfully fetched user data: {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}");

Ta metoda zwraca obiekt UserRecord dla użytkownika odpowiadającego podanemu numerowi telefonu.

Jeśli podany numer telefonu nie należy do istniejącego użytkownika lub nie można pobrać użytkownika z innego powodu, pakiet Admin SDK zgłasza błąd. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Authentication API.

Zbiorcze pobieranie danych użytkowników

Pakiet Firebase Admin SDK umożliwia też pobieranie listy użytkowników na podstawie podanych przez Ciebie identyfikatorów. Użytkowników możesz identyfikować po identyfikatorze użytkownika, adresie e-mail lub numerze telefonu. W jednym wywołaniu można podać maksymalnie 100 identyfikatorów. Identyfikatory mogą zawierać różne typy:

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

Ta metoda zwraca listę o tym samym rozmiarze co lista wejściowa, a każdy wpis zawiera odpowiedni identyfikator UserRecord lub błąd wskazujący, dlaczego nie udało się wyszukać tego identyfikatora. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Authentication API.

Tworzenie konta użytkownika

Pakiet Admin SDK udostępnia metodę, która umożliwia utworzenie nowego użytkownika Firebase Authentication. Ta metoda akceptuje obiekt zawierający informacje o profilu, które mają zostać uwzględnione na nowo utworzonym koncie użytkownika:

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(f'Sucessfully created new user: {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}");

Domyślnie Firebase Authentication wygeneruje losowe uid dla nowego użytkownika. Jeśli chcesz określić własny identyfikator uid dla nowego użytkownika, możesz go podać jako argument przekazywany do metody tworzenia użytkownika:

Node.js

getAuth()
  .createUser({
    uid: 'some-uid',
    email: 'user@example.com',
    phoneNumber: '+11234567890',
  })
  .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()
    .setUid("some-uid")
    .setEmail("user@example.com")
    .setPhoneNumber("+11234567890");

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

Python

user = auth.create_user(
    uid='some-uid', email='user@example.com', phone_number='+15555550100')
print(f'Sucessfully created new user: {user.uid}')

Go

params := (&auth.UserToCreate{}).
	UID(uid).
	Email("user@example.com").
	PhoneNumber("+15555550100")
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()
{
    Uid = "some-uid",
    Email = "user@example.com",
    PhoneNumber = "+11234567890",
};
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}");

Możesz podać dowolną kombinację tych właściwości:

Tabela 1. Właściwości obsługiwane przez operację tworzenia użytkownika

Właściwość Typ Opis
uid tekst uid, który ma zostać przypisany do nowo utworzonego użytkownika. Musi to być ciąg znaków o długości od 1 do 128 znaków (włącznie). Jeśli nie podasz identyfikatora, zostanie automatycznie wygenerowany losowy identyfikator uid. Krótsze wartości uid zapewniają lepszą wydajność.
email tekst Podstawowy adres e-mail użytkownika. Wymagany jest prawidłowy adres e-mail.
emailVerified wartość logiczna Określa, czy podstawowy adres e-mail użytkownika został zweryfikowany. Jeśli nie podasz tej wartości, domyślnie zostanie użyta wartość false.
phoneNumber tekst Podstawowy numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164.
password tekst Niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName tekst Wyświetlana nazwa użytkownika.
photoURL tekst Adres URL zdjęcia użytkownika.
disabled wartość logiczna Określa, czy użytkownik jest wyłączony. true, aby wyłączyć; false, aby włączyć. Jeśli nie podasz tej wartości, domyślnie zostanie użyta wartość false.

Metoda tworzenia użytkownika zwraca obiekt UserRecord dla nowo utworzonego użytkownika.

Jeśli podany adres e-mail lub numer telefonu uid jest już używany przez istniejącego użytkownika lub nie można utworzyć użytkownika z innego powodu, powyższa metoda nie powiedzie się i zostanie wyświetlony błąd. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Aktualizowanie użytkownika

Pakiet Firebase Admin SDK ułatwia modyfikowanie danych istniejącego użytkownika. Musisz podać uid oraz właściwości, które chcesz zaktualizować dla tego użytkownika:

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(f'Sucessfully updated user: {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}");

Możesz podać dowolną kombinację tych właściwości:

Tabela 2. Właściwości obsługiwane przez operację aktualizacji użytkownika

Właściwość Typ Opis
email tekst Nowy podstawowy adres e-mail użytkownika. Wymagany jest prawidłowy adres e-mail.
emailVerified wartość logiczna Określa, czy podstawowy adres e-mail użytkownika został zweryfikowany. Jeśli nie podasz tej wartości, domyślnie zostanie użyta wartość false.
phoneNumber string | null Nowy podstawowy numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164. Ustaw wartość null, aby usunąć istniejący numer telefonu użytkownika.
password tekst Nowe, niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName string | null Nowa wyświetlana nazwa użytkownika. Ustaw wartość null, aby usunąć istniejącą wyświetlaną nazwę użytkownika.
photoURL string | null Nowy adres URL zdjęcia użytkownika. Ustaw wartość null, aby usunąć dotychczasowy adres URL zdjęcia użytkownika. Jeśli nie jest to null, musi być prawidłowym adresem URL.
disabled wartość logiczna Określa, czy użytkownik jest wyłączony. true, aby wyłączyć; false, aby włączyć.

Po zakończeniu aktualizacji metoda aktualizacji użytkownika zwraca zaktualizowany obiekt UserRecord.

Jeśli podany identyfikator uid nie odpowiada istniejącemu użytkownikowi, podany adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika lub nie można zaktualizować użytkownika z jakiegokolwiek innego powodu, powyższa metoda nie powiedzie się i zostanie wyświetlony błąd. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Usuwanie użytkownika

Pakiet Firebase Admin SDK umożliwia usuwanie istniejących użytkowników na podstawie ich uid:

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

Metoda usuwania użytkownika zwraca pusty wynik, gdy usunięcie zakończy się powodzeniem.

Jeśli podany identyfikator uid nie odpowiada istniejącemu użytkownikowi lub nie można go usunąć z innego powodu, metoda usuwania użytkownika zgłasza błąd. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Authentication API.

Usuwanie wielu użytkowników

Pakiet Firebase Admin SDK może też usuwać wielu użytkowników naraz. Pamiętaj jednak, że użycie metod takich jak deleteUsers(uids) do usunięcia wielu użytkowników naraz nie spowoduje aktywacji modułów obsługi zdarzeń onDelete() dla Cloud Functions for Firebase. Dzieje się tak, ponieważ usunięcie zbiorcze nie powoduje wywołania zdarzenia usunięcia użytkownika w przypadku każdego użytkownika. Jeśli chcesz, aby zdarzenia usunięcia użytkownika były wywoływane dla każdego usuniętego użytkownika, usuwaj użytkowników pojedynczo.

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(f'Successfully deleted {result.success_count} users')
print(f'Failed to delete {result.failure_count} users')
for err in result.errors:
    print(f'error #{result.index}, reason: {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}");
}

Metoda usuwania użytkowników zwraca listę błędów dotyczących użytkowników, których nie udało się usunąć. Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Authentication API.

Wyświetlanie listy wszystkich użytkowników

Pakiet Firebase Admin SDK umożliwia pobieranie całej listy użytkowników w partiach:

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

Każda partia wyników zawiera listę użytkowników i token następnej strony używany do wyświetlania następnej partii użytkowników. Gdy wszyscy użytkownicy zostaną już wyświetleni, nie jest zwracany żaden element pageToken.

Jeśli nie podasz pola maxResults, zostanie użyta domyślna wartość 1000 użytkowników na partię. Jest to też maksymalna liczba użytkowników, których można wyświetlić jednocześnie. Każda wartość większa od maksymalnej spowoduje błąd argumentu. Jeśli nie podasz parametru pageToken, operacja wyświetli listę użytkowników od początku, uporządkowaną według parametru uid.

Pełną listę kodów błędów wraz z opisami i instrukcjami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Authentication API.

Skróty haseł wymienionych użytkowników

Ten interfejs API zwraca też wartości passwordSalt i passwordHash zahaszowane przez backend Firebase Auth w przypadku użytkowników haseł, jeśli konto użytkownika lub konto usługi użyte do wygenerowania tokena dostępu OAuth żądania ma uprawnienie firebaseauth.configs.getHashConfig. W przeciwnym razie parametry passwordHash i passwordSalt nie zostaną ustawione.

Ze względu na poufny charakter skrótów haseł konto usługi pakietu Firebase Admin SDK nie ma domyślnie uprawnienia firebaseauth.configs.getHashConfig. Nie możesz dodać uprawnienia bezpośrednio do konta użytkownika lub konta usługi, ale możesz to zrobić pośrednio, tworząc niestandardową rolę uprawnień.

Aby utworzyć niestandardową rolę uprawnień:

  1. Otwórz stronę Role w panelu Administracja w konsoli Google Cloud.
  2. Wybierz projekt z menu u góry strony.
  3. Kliknij UTWÓRZ ROLĘ.
  4. Kliknij DODAJ UPRAWNIENIA.
  5. Wyszukaj uprawnienie firebaseauth.configs.getHashConfig i zaznacz odpowiednie pole wyboru.
  6. Kliknij DODAJ.
  7. Kliknij UTWÓRZ, aby zakończyć tworzenie nowej roli.

Dodaj utworzoną rolę niestandardową do konta użytkownika lub usługi na stronie Uprawnienia:

  1. W panelu Administracja wybierz Uprawnienia.
  2. Wybierz konto usługi lub konto użytkownika z listy użytkowników do edycji.
  3. Kliknij DODAJ KOLEJNĄ ROLĘ.
  4. Wyszukaj utworzoną wcześniej nową rolę niestandardową.
  5. Kliknij ZAPISZ.