Zarządzanie użytkownikami

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

  • Tworzenie nowych użytkowników bez ograniczania przepustowości.
  • Możesz wyszukiwać użytkowników według różnych kryteriów, takich jak UID, adres e-mail czy numer telefonu.
  • Wyświetlenie listy wszystkich użytkowników z określonego projektu partiami.
  • Dostęp do metadanych użytkowników, w tym daty utworzenia konta i ostatniego logowania.
  • Usuń użytkowników bez konieczności podawania hasła.
  • Aktualizuj właściwości użytkownika (w tym hasło) bez konieczności logowania się jako użytkownik.
  • Weryfikuj adresy e-mail bez konieczności wykonywania dodatkowych czynności przy weryfikowaniu adresów e-mail.
  • Aby cofnąć te zmiany, zmień adres e-mail użytkownika bez wysyłania linków.
  • Możesz utworzyć nowe konto użytkownika z numerem telefonu bez konieczności potwierdzania tożsamości za pomocą SMS-ów.
  • Zmiana numeru telefonu użytkownika bez przechodzenia procesu weryfikacji za pomocą SMS-a.
  • Udostępnij offline użytkownikom w stanie wyłączonym, a następnie kontroluj, kiedy mają je włączać.
  • Twórz niestandardowe konsole użytkowników dostosowane do systemu zarządzania użytkownikami określonej aplikacji.

Zanim zaczniesz

Aby korzystać z interfejsu API do zarządzania użytkownikami dostępnego w pakiecie 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

Podstawowym sposobem identyfikacji użytkownika jest jego uid, czyli unikalny identyfikator. Pakiet Admin SDK udostępnia metodę, która umożliwia pobieranie informacji profilowych użytkowników według 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 w przypadku użytkownika obiekt UserRecord odpowiadający wartości uid przekazanej metodowi.

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

W niektórych przypadkach zamiast uid będziesz mieć adres e-mail użytkownika. Pakiet 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 w przypadku użytkownika obiekt UserRecord odpowiadający 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 żadnego innego powodu, pakiet Admin SDK zgłosi błąd. Pełną listę kodów błędów, w tym opisy i sposoby rozwiązywania problemów, znajdziesz w artykule Błędy interfejsu Admin Authentication API.

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 w przypadku użytkownika obiekt UserRecord odpowiadający podanemu numerowi telefonu.

Jeśli podany numer telefonu nie należy do istniejącego użytkownika lub nie można go pobrać z jakiegokolwiek innego powodu, pakiet Admin SDK wyświetli błąd. Pełną listę kodów błędów, w tym opisy i sposoby 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ć na podstawie ich identyfikatora, adresu e-mail lub numeru telefonu. W jednym wywołaniu można podać maksymalnie 100 identyfikatorów. Mogą one obejmować różne typy identyfikatorów:

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);
  });
manage_users.js

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 takim samym rozmiarze jak lista danych wejściowych, a każdy wpis zawiera odpowiedni element UserRecord lub błąd informujący o tym, dlaczego nie udało się wyszukać danego identyfikatora. Pełną listę kodów błędów wraz z opisami i sposobami 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 pozwala utworzyć nowego użytkownika Uwierzytelniania Firebase. Ta metoda akceptuje obiekt zawierający informacje o profilu do uwzględnienia 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);
  });
manage_users.js

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)
auth.go

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 Uwierzytelnianie Firebase wygeneruje losowy uid dla nowego użytkownika. Jeśli zamiast tego chcesz określić własną właściwość uid dla nowego użytkownika, możesz dołączyć ten argument 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);
  });
manage_users.js

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('Sucessfully created new user: {0}'.format(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)
auth.go

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 string, 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 podany, automatycznie zostanie wygenerowany losowy uid. Krótsze uid zapewniają większą skuteczność.
email string, Główny adres e-mail użytkownika. Wymagany jest prawidłowy adres e-mail.
emailVerified boolean, Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany. Jeśli nie zostanie podana, domyślna wartość to false.
phoneNumber string, Podstawowy numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164.
password string, Nieprzetworzone, niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName string, Wyświetlana nazwa użytkownika.
photoURL string, Adres URL zdjęcia użytkownika.
disabled boolean, Wskazuje, czy użytkownik jest wyłączony. true – wyłączona, false – włączona. Jeśli nie zostanie podana, domyślna wartość to false.

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

Jeśli podany identyfikator uid, adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika albo nie można utworzyć użytkownika z jakiegokolwiek innego powodu, powyższa metoda zakończy się niepowodzeniem. Pełną listę kodów błędów, w tym opisy i sposoby rozwiązywania problemów, znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Aktualizowanie konta użytkownika

Pakiet SDK Firebase Admin umożliwia modyfikowanie danych obecnego użytkownika. Musisz podać właściwość uid wraz z właściwościami, które mają być aktualizowane w przypadku 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);
  });
manage_users.js

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)
auth.go

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 string, Nowy główny adres e-mail użytkownika. Wymagany jest prawidłowy adres e-mail.
emailVerified boolean, Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany. Jeśli nie zostanie podana, domyślna wartość to false.
phoneNumber string, Nowy podstawowy numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164. Ustaw jako null, aby usunąć dotychczasowy numer telefonu użytkownika.
password string, Nowe surowe, niezaszyfrowane hasło użytkownika. Musi składać się z co najmniej 6 znaków.
displayName ciąg znaków | null Nowa wyświetlana nazwa użytkowników. Ustaw jako null, aby usunąć dotychczasową wyświetlaną nazwę użytkownika.
photoURL ciąg znaków | null Nowy adres URL zdjęcia użytkownika. Ustaw jako null, aby usunąć adres URL zdjęcia użytkownika. Jeśli wartość jest inna niż null, musisz podać prawidłowy adres URL.
disabled boolean, Wskazuje, czy użytkownik jest wyłączony. true – wyłączona, false – włączona.

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

Jeśli podany uid nie odpowiada istniejącemu użytkownikowi, podany adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika albo użytkownika nie można zaktualizować z żadnego innego powodu, użycie powyższej metody zakończy się błędem. Pełną listę kodów błędów, w tym opisy i sposoby rozwiązywania problemów, znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Usuwanie konta użytkownika

Pakiet Firebase Admin SDK umożliwia usuwanie dotychczasowych użytkowników za pomocą 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.");

Po ukończeniu usuwania metoda usuwania użytkownika zwraca pusty wynik.

Jeśli podany uid nie odpowiada istniejącemu użytkownikowi lub użytkownika nie można usunąć z jakiegokolwiek innego powodu, metoda usuwania użytkownika zwróci błąd. Pełną listę kodów błędów, w tym opisy i sposoby rozwiązywania problemów, znajdziesz w artykule Błędy interfejsu Admin Authentication API.

Usuń wielu użytkowników

Za pomocą pakietu Firebase Admin SDK możesz usunąć wielu użytkowników naraz. Pamiętaj jednak, że jednorazowe usuwanie wielu użytkowników za pomocą metod takich jak deleteUsers(uids) nie aktywuje modułów obsługi zdarzeń onDelete() dla Cloud Functions dla Firebase. Dzieje się tak, ponieważ usuwanie zbiorcze nie wywołuje zdarzenia usunięcia użytkownika w przypadku każdego użytkownika. Usuwaj konta użytkowników pojedynczo, jeśli chcesz, aby zdarzenia usuwania użytkowników były uruchamiane w przypadku każdego usuniętego konta użytkownika.

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, których nie udało się usunąć. Pełną listę kodów błędów, w tym opisy i sposoby rozwiązywania problemów, znajdziesz w artykule Błędy interfejsu Admin Authentication API.

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 grupa wyników zawiera listę użytkowników i token następnej strony, który służy do wyświetlenia następnej grupy użytkowników. Gdy wszyscy użytkownicy są już na liście, parametr pageToken nie jest zwracany.

Jeśli nie podasz żadnego pola maxResults, zostanie użyte domyślne 1000 użytkowników na grupę. Jest to także maksymalna dozwolona liczba użytkowników na liście jednocześnie. Każda wartość większa od wartości maksymalnej powoduje błąd argumentu. Jeśli nie określisz elementu pageToken, operacja spowoduje wyświetlenie listy użytkowników od początku w kolejności uid.

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

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

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

Ze względu na poufny charakter haszów haseł konto usługi Firebase Admin SDK domyślnie nie ma uprawnienia firebaseauth.configs.getHashConfig. Nie można dodać uprawnień bezpośrednio do konta użytkownika lub 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 w menu u góry strony.
  3. Kliknij UTWÓRZ ROLĘ.
  4. Kliknij DODAJ UPRAWNIENIA.
  5. Wyszukaj uprawnienie firebaseauth.configs.getHashConfig i zaznacz to pole wyboru.
  6. Kliknij DODAJ
  7. Aby zakończyć tworzenie nowej roli, kliknij UTWÓRZ.

Na stronie uprawnień dodaj utworzoną rolę niestandardową do konta użytkownika lub usługi:

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