Zarządzanie użytkownikami

Pakiet SDK Firebase Admin udostępnia interfejs API do zarządzania Firebase Authentication użytkowników z podwyższonymi uprawnieniami. Interfejs Admin User Management API pozwala programowo wykonywać następujące zadania bezpieczne środowisko serwera:

• Tworzenie nowych użytkowników bez ograniczania przepustowości.
• wyszukiwać użytkowników według różnych kryteriów, np. identyfikatora UID, adresu e-mail lub numeru telefonu;
• Wyświetlenie listy wszystkich użytkowników z określonego projektu partiami.
• dostęp do metadanych użytkownika, w tym daty utworzenia konta i ostatniego logowania;
• Usuwanie użytkowników bez konieczności podawania przez nich hasła.
• aktualizować właściwości użytkownika (w tym jego hasło) bez konieczności logowania się jako ten użytkownik;
• weryfikować e-maile bez konieczności korzystania z zewnętrznych procesów weryfikacji e-maili;
• Aby cofnąć te zmiany, zmień adres e-mail użytkownika bez wysyłania linków.
• Utwórz nowego użytkownika z numerem telefonu bez przechodzenia przez proces weryfikacji SMS-em.
• Zmiana numeru telefonu użytkownika bez weryfikacji za pomocą wiadomości SMS przepływu danych.
• Udostępnianie offline użytkownikom w stanie wyłączonym, a następnie kontrolowanie, kiedy mają włączyć je.
• Tworzenie niestandardowych konsol użytkowników dostosowanych do użytkownika określonej aplikacji systemu zarządzania.

Zanim zaczniesz

Aby korzystać z interfejsu API do zarządzania użytkownikami udostępnianego przez pakiet Firebase Admin SDK, musisz mieć konto usługi. Postępuj zgodnie z instrukcjami konfiguracji. , aby dowiedzieć się więcej o inicjowaniu pakietu Admin SDK.

Pobieranie danych użytkownika

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

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

Jeśli podany uid nie należy do istniejącego użytkownika lub nie można go pobrane z dowolnego innego powodu, powyższa metoda zwraca błąd. Pełną listę kodów błędów, w tym ich opisy i procedury rozwiązywania problemów zawiera artykuł Błędy interfejsu Admin Auth API.

W niektórych przypadkach zamiast adresu uid będziesz mieć adres e-mail użytkownika. Firebase Admin SDK obsługuje wyszukiwanie informacji o użytkownikach 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('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}");

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

Jeśli podany adres e-mail nie należy do istniejącego użytkownika lub użytkownik nie może pobrane z jakiegokolwiek innego powodu, pakiet Admin SDK zwraca błąd. Pełną listę kodów błędów wraz z opisami i sposoby ich rozwiązywania znajdziesz w artykule Błędy interfejsu API Authentication administratora.

Ostrzeżenie: w przypadku wyszukiwania e-maili możesz wyszukiwać tylko główne (najwyższe) e-maile, a nie e-maile od konkretnego dostawcy. Jeśli na przykład konto na Facebooku z atrybutem inny adres e-mail [e-mail] jest powiązany z istniejącym użytkownikiem z kontem wyślij e-maila na adres [e-mail], dzwonię pod numer getUserByEmail("[e-mail]") nie przyniesie żadnych wyników, a getUserByEmail("[e-mail]") zwróci do oczekiwanych użytkowników. W przypadku domyślnego ustawienia „jedno konto na adres e-mail” pierwszy adres e-mail użyty do zalogowania będzie używany jako adres e-mail najwyższego poziomu, chyba że zostanie później zmieniony. Jeśli ustawisz opcję „Wiele kont na 1 adres e-mail”, adres e-mail główny zostanie ustawiony tylko wtedy, gdy utworzysz użytkownika z hasłem, chyba że zaktualizujesz go ręcznie.

W innych przypadkach zamiast uid będziesz mieć numer telefonu użytkownika. Pakiet SDK Firebase Admin obsługuje wyszukiwanie informacji o użytkownikach 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('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}");

Ta metoda zwraca obiekt UserRecord dla argumentu odpowiadający podanemu numerowi telefonu.

Jeśli podany numer telefonu nie należy do żadnego użytkownika lub nie można go pobrać z jakiegokolwiek innego powodu, pakiet SDK Admin zwraca błąd. Pełną listę kodów błędów wraz z opisami i sposoby ich rozwiązywania znajdziesz w artykule Błędy interfejsu API Authentication administratora.

Zbiorcze pobieranie danych użytkowników

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

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 danych wejściowych, przy czym każdy wpis zawierające odpowiedni element UserRecord lub błąd wskazujący przyczynę nie udało się znaleźć tego identyfikatora. Pełną listę kodów błędów znajdziesz w tym opisy i sposoby rozwiązania problemu, zapoznaj się z informacjami o interfejsie Admin Authentication API Błędy.

Tworzenie konta użytkownika

Pakiet Admin SDK udostępnia metodę, która umożliwia utworzenie nowego konta użytkownika Firebase Authentication. Ta metoda akceptuje obiekt zawierający informacje o profilu, które mają zostać uwzględnione w nowo utworzonym konto 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('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}");

Domyślnie Firebase Authentication wygeneruje losowe uid dla nowego użytkownika. Jeśli zamiast tego chcesz dla nowego użytkownika określić własny uid, 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('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}");

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óry ma zostać przypisany do nowo utworzonego użytkownika. Musi to być ciąg o długości od 1 do 128 znaków włącznie. Jeśli nie zostanie podana, parametr zostanie automatycznie wygenerowana losowa wartość uid. Krótsze uid zapewniają lepszą wydajność.
email	ciąg znaków	Główny adres e-mail użytkownika. Wymagany jest prawidłowy adres e-mail.
emailVerified	wartość logiczna	Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany. Jeśli nie podasz żadnej opcji, zostanie użyta wartość domyślna false.
phoneNumber	ciąg znaków	Podstawowy numer telefonu użytkownika. Musi być prawidłową specyfikacją E.164 numeru telefonu.
password	ciąg znaków	Nieprzetworzone, niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName	ciąg znaków	Dane użytkowników wyświetlaną nazwę.
photoURL	ciąg znaków	Adres URL zdjęcia użytkownika.
disabled	wartość logiczna	Czy użytkownik jest wyłączony. true – wyłączone; false – włączone. Jeśli nie podasz żadnej opcji, domyślna wartość to false.

Uwaga: wszystkie powyższe właściwości są opcjonalne. Jeśli nie podasz określonej właściwości, 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ącą użytkownika lub użytkownika nie można utworzyć z żadnego innego powodu, powyższa metoda nie powiedzie się z błędem. Pełną listę kodów błędów, w tym ich opisy i sposoby rozwiązywania, znajdziesz w artykule Błędy interfejsu API Authentication dla administratorów.

Aktualizowanie konta użytkownika

Pakiet SDK Firebase Admin ułatwia modyfikowanie danych istniejącego użytkownika. Musisz podać uid wraz z właściwościami, które chcesz zaktualizować dla 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('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}");

Można 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	Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany. Jeśli nie podasz żadnej opcji, zostanie użyta wartość domyślna false.
phoneNumber	ciąg znaków	Nowy główny numer telefonu użytkownika. Musi być prawidłową specyfikacją E.164 numeru telefonu. Ustaw na null, aby wyczyścić istniejący numer telefonu użytkownika.
password	ciąg znaków	Nowe surowe, niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName	ciąg znaków | null	Dane użytkowników nową wyświetlaną nazwę. Ustaw na null, aby usunąć dotychczasową wyświetlaną nazwę użytkownika.
photoURL	ciąg tekstowy | null	Dane użytkowników nowy adres URL zdjęcia. Ustaw na null, aby wyczyścić obecny adres URL zdjęcia użytkownika. Jeśli nie jest to null, musi być prawidłowym adresem URL.
disabled	wartość logiczna	Czy użytkownik jest wyłączony. true – wyłączono; false dla włączonego.

Uwaga: wszystkie wymienione powyżej właściwości są opcjonalne. Jeśli nie określisz określonej właściwości, jej obecna wartość pozostanie niezmieniona.

Metoda aktualizacji użytkownika zwraca zaktualizowany obiekt UserRecord, gdy zakończono aktualizację.

Jeśli podana wartość uid nie odpowiada istniejącemu użytkownikowi, zostanie podana wartość adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika albo aktualizacji z jakiegokolwiek innego powodu, powyższa metoda zakończy się niepowodzeniem i . Pełną listę kodów błędów wraz z opisami i rozwiązaniami czynności znajdziesz w artykule Błędy interfejsu API administratora Authentication.

Usuwanie użytkownika

Pakiet Firebase Admin SDK umożliwia usuwanie istniejących użytkowników według 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.");

Metoda usuwania użytkownika zwraca pusty wynik po zakończeniu usuwania. .

Jeśli podany uid nie odpowiada istniejącemu użytkownikowi lub użytkownik nie może zostaną usunięte z jakiegokolwiek innego powodu, metoda delete spowoduje błąd. Pełną listę kodów błędów, w tym ich opisy i sposoby rozwiązywania, znajdziesz w artykule Błędy interfejsu API Authentication.

Usuń wielu użytkowników

Pakiet Admin SDK Firebase umożliwia też usuwanie wielu użytkowników naraz. Pamiętaj jednak, że użycie metody takiej jak deleteUsers(uids) do usunięcia wielu użytkowników jednocześnie nie spowoduje wywołania metod obsługi zdarzeń onDelete() dla Cloud Functions for Firebase. Dzieje się tak, ponieważ zbiorcze usunięcie nie powoduje utworzenia zdarzenia usunięcia użytkownika w przypadku każdego z nich. Usuwaj użytkowników pojedynczo, jeśli chcesz, aby zdarzenia usuwania użytkowników były wywoływane w przypadku każdego usuniętego konta.

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

Metoda usuwania użytkowników zwraca listę błędów dotyczących kont użytkowników, nie można usunąć. Pełną listę kodów błędów wraz z opisami i sposoby ich rozwiązywania znajdziesz w artykule Błędy interfejsu API Authentication administratora.

Wyświetl wszystkich użytkowników

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

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. Jeśli wszyscy użytkownicy są już na liście, nie będzie Zwracana jest wartość pageToken.

Jeśli nie podasz żadnego pola maxResults, zostanie użyte domyślne 1000 użytkowników na grupę. Jest to też maksymalna liczba użytkowników, których można wyświetlić na liście jednocześnie. Każda wartość większa od maksymalnej spowoduje błąd argumentu. Jeśli nie określisz pola pageToken, operacja wyświetli listę użytkowników od początku, posortowaną według pola uid.

Pełną listę kodów błędów, w tym ich opisy i sposoby rozwiązywania, znajdziesz w artykule Błędy interfejsu API Authentication.

Hashe haseł na liście użytkowników

Ten interfejs API zwraca również wartości passwordSalt i passwordHash zahaszowane przez Backend uwierzytelniania Firebase dla użytkowników haseł, jeśli konto użytkownika/usługi wcześniej musi wygenerować token dostępu OAuth żądania Uprawnienia: firebaseauth.configs.getHashConfig. W przeciwnym razie wartości passwordHash i passwordSalt nie zostaną ustawione.

Ze względu na poufny charakter haszy haseł usługa Firebase Admin SDK konto nie ma uprawnienia firebaseauth.configs.getHashConfig przez wartość domyślną. Nie możesz dodać uprawnień bezpośrednio do konta użytkownika/usługi, ale może to robić pośrednio przez utworzyć niestandardową rolę uprawnień.

Aby utworzyć niestandardową rolę uprawnień:

1. Otwórz stronę Role w sekcji Administracja w panelu administracyjnym w konsoli Google Cloud.
2. Wybierz projekt w 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. 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 sekcji Administracja panelu administratora, wybierz Uprawnienia.
2. Na liście członków wybierz 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 rola zapewnia uprawnienia wykraczające poza zamierzony zakres.