Zarządzanie użytkownikami

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

• Tworzenie nowych użytkowników bez ograniczania przepustowości ani limitów szybkości.
• Wyszukuj użytkowników według różnych kryteriów, takich jak identyfikator UID, adres e-mail lub numer telefonu.
• Wyświetlanie listy wszystkich użytkowników określonego projektu w partiach.
• uzyskiwać dostęp do metadanych użytkownika, w tym daty utworzenia konta i daty ostatniego logowania;
• Usuwanie użytkowników bez konieczności podawania ich dotychczasowego hasła.
• aktualizować właściwości użytkownika, w tym hasło, bez konieczności logowania się jako użytkownik;
• Weryfikowanie adresów e-mail bez konieczności przechodzenia przez procesy weryfikacji poza pasmem.
• zmienić adres e-mail użytkownika bez wysyłania linków w e-mailach, aby cofnąć te zmiany;
• Utwórz nowego użytkownika z numerem telefonu bez konieczności przechodzenia procesu weryfikacji SMS-em.
• zmieniać numer telefonu użytkownika bez konieczności przechodzenia procesu weryfikacji SMS-em;
• Udostępniaj użytkownikom konta offline w stanie wyłączonym, a potem decyduj, kiedy je włączyć.
• Twórz niestandardowe konsole użytkownika dostosowane do systemu zarządzania użytkownikami konkretnej aplikacji.

Zanim zaczniesz

Aby korzystać z interfejsu API do 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

Głównym sposobem identyfikowania użytkownika jest jego uid, czyli unikalny identyfikator tego użytkownika. Pakiet Admin SDK udostępnia metodę, która umożliwia pobieranie informacji z 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);
  });
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(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)
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}");

Ta metoda zwraca obiekt UserRecord użytkownika odpowiadający wartości uid przekazanej do metody.

Jeśli podany identyfikator uid nie należy do istniejącego użytkownika lub nie można go pobrać z innego powodu, powyższa metoda zwraca 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 będziesz mieć adres e-mail użytkownika. Pakiet Firebase Admin SDK umożliwia 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);
  });
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(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)
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}");

Ta metoda zwraca obiekt UserRecord 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 go pobrać z innego powodu, pakiet SDK administratora zgłosi błąd. Pełną listę kodów błędów wraz z opisami i krokami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Ostrzeżenie: w przypadku wyszukiwania e-maili możesz wyszukiwać tylko główne e-maile (najwyższego poziomu), a nie e-maile specyficzne dla dostawcy. Jeśli na przykład konto na Facebooku z innym adresem e-mail [e-mail] jest połączone z istniejącym użytkownikiem, który ma adres e-mail [e-mail], wywołanie getUserByEmail("[e-mail]") nie przyniesie żadnych wyników, a wywołanie getUserByEmail("[e-mail]") zwróci oczekiwanego użytkownika. W przypadku domyślnego ustawienia „jedno konto na adres e-mail” pierwszy adres e-mail użyty do logowania będzie używany jako adres e-mail najwyższego poziomu, chyba że zostanie później zmieniony. Gdy ustawiona jest opcja „Wiele kont na 1 adres e-mail”, główny adres e-mail jest ustawiany tylko wtedy, gdy tworzony jest użytkownik z hasłem, chyba że zostanie ręcznie zaktualizowany.

W innych przypadkach zamiast uid użytkownika będziesz mieć jego numer telefonu. Pakiet Firebase Admin SDK umożliwia 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);
  });
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(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)
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}");

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

Jeśli podany numer telefonu nie należy do istniejącego użytkownika lub nie można go pobrać z innego powodu, pakiet Admin SDK zgłosi błąd. Pełną listę kodów błędów wraz z opisami i krokami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin 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ć za pomocą identyfikatora użytkownika, adresu e-mail lub numeru 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: '[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}");
}

Ta metoda zwraca listę o takim samym rozmiarze jak lista wejściowa. Każdy element zawiera odpowiedni obiekt UserRecord lub błąd wskazujący, dlaczego nie udało się wyszukać danego identyfikatora. Pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, znajdziesz w artykule Błędy interfejsu Admin 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: '[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(f'Sucessfully created new user: {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}");

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

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

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	ciąg znaków	uid, którą chcesz przypisać nowo utworzonemu użytkownikowi. Musi to być ciąg znaków o długości od 1 do 128 znaków włącznie. Jeśli nie podasz wartości, automatycznie wygenerujemy losową wartość uid. Krótsze uids są skuteczniejsze.
email	ciąg znaków	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 jest zweryfikowany. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna false.
phoneNumber	ciąg znaków	Główny numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164.
password	ciąg znaków	Niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName	ciąg znaków	Wyświetlana nazwa użytkownika.
photoURL	ciąg znaków	Adres URL zdjęcia użytkownika.
disabled	Wartość logiczna	Określa, czy użytkownik jest wyłączony. true – wyłączone; false – włączone. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna false.

Uwaga: wszystkie powyższe właściwości są opcjonalne. Jeśli określona właściwość nie jest podana, jej wartość będzie pusta, chyba że w tabeli powyżej podano wartość domyślną.

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

Jeśli podany uid, adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika lub nie można utworzyć użytkownika z innego powodu, powyższa metoda kończy się niepowodzeniem i zwraca błąd. Pełną listę kodów błędów wraz z opisami i krokami 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 wraz z właściwościami, które chcesz zaktualizować w przypadku tego użytkownika:

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

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	ciąg znaków	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 jest zweryfikowany. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna false.
phoneNumber	ciąg znaków	Nowy główny numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164. Ustaw wartość null, aby wyczyścić dotychczasowy numer telefonu użytkownika.
password	ciąg znaków	Nowe, niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName	string | null	Nowa wyświetlana nazwa użytkowników. Ustaw wartość null, aby wyczyścić wyświetlaną nazwę użytkownika.
photoURL	string | null	Nowy adres URL zdjęcia użytkownika. Ustaw wartość null, aby wyczyścić dotychczasowy adres URL zdjęcia użytkownika. Jeśli wartość nie jest null, musi to być prawidłowy adres URL.
disabled	Wartość logiczna	Określa, czy użytkownik jest wyłączony. true – wyłączone; false – włączone.

Uwaga: wszystkie powyższe właściwości są opcjonalne. Jeśli określona właściwość nie jest podana, jej dotychczasowa wartość pozostaje bez zmian.

Metoda aktualizacji użytkownika zwraca zaktualizowany obiekt UserRecord, gdy aktualizacja zostanie zakończona.

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 innego powodu, powyższa metoda zakończy się niepowodzeniem i zwróci błąd. Pełną listę kodów błędów wraz z opisami i krokami 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: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.");

Gdy usuwanie zakończy się pomyślnie, metoda usuwania użytkownika zwróci pusty wynik.

Jeśli podany identyfikator uid nie odpowiada istniejącemu użytkownikowi lub nie można go usunąć z innego powodu, metoda usuwania użytkownika zwraca błąd. Pełną listę kodów błędów wraz z opisami i krokami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin 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żywanie metod takich jak deleteUsers(uids) do usuwania wielu użytkowników naraz nie spowoduje wywołania modułów obsługi zdarzeń onDelete() dla Cloud Functions for Firebase. Dzieje się tak, ponieważ usuwanie 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 w przypadku 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 delete users 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 krokami rozwiązywania problemów znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Wyświetlanie 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();
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}");
}

Każda partia wyników zawiera listę użytkowników i token następnej strony, który służy do wyświetlania kolejnej partii użytkowników. Gdy wszyscy użytkownicy zostaną już wymienieni, zwracana jest wartość no pageToken.

Jeśli nie podasz pola maxResults, użyjemy domyślnej wartości 1000 użytkowników na partię. Jest to też maksymalna liczba użytkowników, którzy mogą być wyświetlani 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, posortowaną według parametru uid.

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

skróty haseł wymienionych użytkowników,

Ten interfejs API zwraca też hasze passwordSalt i passwordHash wygenerowane przez backend Firebase Auth dla użytkowników korzystających z hasła, jeśli użytkownik lub konto usługi użyte do wygenerowania tokena dostępu OAuth w żądaniu ma uprawnienie firebaseauth.configs.getHashConfig. W przeciwnym razie wartości 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ć uprawnień bezpośrednio do użytkownika lub konta usługi, ale możesz to zrobić pośrednio, tworząc niestandardową rolę IAM.

Aby utworzyć niestandardową rolę uprawnień:

1. W panelu Administracja w konsoli Google Cloud otwórz stronę Role.
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 pole wyboru.
6. Kliknij DODAJ.
7. Aby zakończyć tworzenie nowej roli, kliknij UTWÓRZ.

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

1. W panelu Administracja kliknij Uprawnienia.
2. Wybierz z listy członków konto usługi lub użytkownika, które chcesz edytować.
3. Kliknij DODAJ KOLEJNĄ ROLĘ.
4. Wyszukaj nową, utworzoną wcześniej rolę niestandardową.
5. Kliknij ZAPISZ.

Ostrzeżenie: nie używaj roli Editor do dodawania uprawnienia firebaseauth.configs.getHashConfig. Ta zaawansowana rola przyznaje uprawnienia wykraczające poza zamierzony zakres.