Zarządzanie użytkownikami

Pakiet Firebase Admin SDK zapewnia interfejs API do zarządzania użytkownikami Firebase Authentication z podwyższonymi uprawnieniami. Interfejs API do zarządzania użytkownikami administracyjnymi umożliwia programowe wykonywanie następujących zadań w bezpiecznym środowisku serwerowym:

• Twórz nowych użytkowników bez ograniczania przepustowości lub szybkości.
• Wyszukaj użytkowników według różnych kryteriów, takich jak identyfikator użytkownika, adres e-mail lub numer telefonu.
• Wyświetl listę wszystkich użytkowników określonego projektu w partiach.
• Uzyskaj dostęp do metadanych użytkownika, w tym daty utworzenia konta i daty ostatniego logowania.
• Usuń użytkowników bez wymagania ich istniejącego hasła.
• Aktualizuj właściwości użytkownika — w tym jego hasło — bez konieczności logowania się jako użytkownik.
• Weryfikuj wiadomości e-mail bez konieczności wykonywania przepływów działań poza pasmem w celu weryfikacji wiadomości e-mail.
• 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 procedurę weryfikacji SMS-em.
• Udostępniaj użytkowników w trybie offline w stanie wyłączonym, a następnie kontroluj, kiedy ich włączyć.
• Twórz niestandardowe konsole użytkownika, które są dostosowane do systemu zarządzania użytkownikami określonej 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. Postępuj zgodnie z instrukcjami konfiguracji, aby uzyskać więcej informacji o inicjowaniu pakietu Admin SDK.

Pobierz dane użytkownika

Podstawowym sposobem identyfikacji użytkownika jest jego uid , unikalny identyfikator tego użytkownika. 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);
  });

Jawa

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());

Pyton

from firebase_admin import auth

user = auth.get_user(uid)
print('Successfully fetched user data: {0}'.format(user.uid))

Iść

// 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 uid użytkownika podanemu metodzie.

Jeśli podany uid nie należy do istniejącego użytkownika lub użytkownika nie można pobrać z jakiegokolwiek innego powodu, powyższa metoda zgłasza błąd. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

W niektórych przypadkach będziesz mieć adres e-mail użytkownika zamiast jego uid . Pakiet Firebase Admin SDK obsługuje wyszukiwanie informacji o użytkownikach za pomocą wiadomości 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);
  });

Jawa

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());

Pyton

from firebase_admin import auth

user = auth.get_user_by_email(email)
print('Successfully fetched user data: {0}'.format(user.uid))

Iść

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 użytkownika odpowiadającego podanemu e-mailowi.

Jeśli podany adres e-mail nie należy do istniejącego użytkownika lub użytkownika nie można pobrać z jakiegokolwiek innego powodu, pakiet Admin SDK zgłasza błąd. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Ostrzeżenie: w przypadku wyszukiwania wiadomości e-mail można przeszukiwać tylko główną (najwyższego poziomu) wiadomość e-mail, a nie wiadomości e-mail określonego dostawcy. Na przykład, jeśli konto na Facebooku z innym adresem e-mail [e-mail] jest połączone z istniejącym użytkownikiem z adresem e-mail [e-mail] , wywołanie getUserByEmail("[e-mail]") nie przyniesie żadnych wyników, podczas gdy getUserByEmail("[e-mail]") zwróci oczekiwanego użytkownika. W przypadku domyślnego ustawienia „pojedyncze konto na adres e-mail” pierwszy adres e-mail używany do logowania będzie używany jako adres e-mail najwyższego poziomu, chyba że zostanie później zmieniony. Gdy ustawione jest „wiele kont na e-mail”, główny adres e-mail jest ustawiany tylko wtedy, gdy tworzone jest hasło użytkownika, chyba że zostanie zaktualizowany ręcznie.

W innych przypadkach będziesz mieć numer telefonu użytkownika zamiast jego uid 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);
  });

Jawa

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());

Pyton

from firebase_admin import auth

user = auth.get_user_by_phone_number(phone)
print('Successfully fetched user data: {0}'.format(user.uid))

Iść

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 użytkownika odpowiadającego podanemu numerowi telefonu.

Jeśli podany numer telefonu nie należy do istniejącego użytkownika lub użytkownika nie można pobrać z jakiegokolwiek innego powodu, pakiet Admin SDK zgłasza błąd. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Zbiorcze pobieranie danych użytkownika

Pakiet Firebase Admin SDK umożliwia też pobieranie listy użytkowników na podstawie podanych przez Ciebie identyfikatorów. Możesz identyfikować użytkowników za pomocą ich identyfikatora użytkownika, adresu e-mail lub numeru telefonu. W jednym wywołaniu można podać maksymalnie 100 identyfikatorów. Identyfikatory mogą zawierać kombinację typów:

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

Jawa

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

Pyton

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)

Iść

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, z każdym wpisem zawierającym odpowiedni UserRecord lub błąd wskazujący, dlaczego nie można było wyszukać tego identyfikatora. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Utwórz użytkownika

Pakiet Admin SDK zapewnia 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 w 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);
  });

Jawa

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());

Pyton

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))

Iść

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 uwierzytelnianie uid wygeneruje losowy identyfikator użytkownika dla nowego użytkownika. Jeśli zamiast tego chcesz określić własny uid użytkownika dla nowego użytkownika, możesz dołączyć go jako argument przekazany 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);
  });

Jawa

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());

Pyton

user = auth.create_user(
    uid='some-uid', email='[e-mail]', phone_number='[phone]')
print('Sucessfully created new user: {0}'.format(user.uid))

Iść

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żna podać dowolną kombinację następujących właściwości:

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

Nieruchomość	Rodzaj	Opis
uid	strunowy	uid użytkownika do przypisania do nowo utworzonego użytkownika. Musi być ciągiem znaków o długości od 1 do 128 włącznie. Jeśli nie zostanie podany, losowy uid zostanie wygenerowany automatycznie. Krótsze uid oferują lepszą wydajność.
email	strunowy	Główny adres e-mail użytkownika. Musi to być prawidłowy adres e-mail.
emailVerified	logiczna	Czy podstawowy adres e-mail użytkownika jest weryfikowany. Jeśli nie zostanie podany, wartością domyślną jest false .
phoneNumber	strunowy	Podstawowy numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164.
password	strunowy	Surowe, niezaszyfrowane hasło użytkownika. Musi mieć co najmniej sześć znaków.
displayName	strunowy	Nazwa wyświetlana użytkowników.
photoURL	strunowy	Adres URL zdjęcia użytkownika.
disabled	logiczna	Czy użytkownik jest wyłączony. true dla osób niepełnosprawnych; false dla włączonych. Jeśli nie zostanie podany, wartością domyślną jest false .

Uwaga: Wszystkie powyższe właściwości są opcjonalne. Jeśli określona właściwość nie zostanie określona, ​​wartość tej właściwości będzie pusta, chyba że w powyższej tabeli wymieniono wartość domyślną.

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

Jeśli podany uid użytkownika, adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika lub użytkownika nie można utworzyć z jakiegokolwiek innego powodu, powyższa metoda kończy się niepowodzeniem i błędem. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Zaktualizuj użytkownika

Pakiet Firebase Admin SDK ułatwia modyfikowanie danych istniejącego użytkownika. Musisz określić uid użytkownika wraz z właściwościami do aktualizacji 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);
  });

Jawa

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());

Pyton

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))

Iść

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ę następujących właściwości:

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

Nieruchomość	Rodzaj	Opis
email	strunowy	Nowy główny adres e-mail użytkownika. Musi to być prawidłowy adres e-mail.
emailVerified	logiczna	Czy podstawowy adres e-mail użytkownika jest weryfikowany. Jeśli nie zostanie podany, wartością domyślną jest false .
phoneNumber	strunowy	Nowy podstawowy numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164. Ustaw null , aby wyczyścić istniejący numer telefonu użytkownika.
password	strunowy	Nowe nieprzetworzone, niezaszyfrowane hasło użytkownika. Musi mieć co najmniej sześć znaków.
displayName	ciąg | null	Nowa nazwa wyświetlana użytkowników. Ustaw null , aby wyczyścić istniejącą nazwę wyświetlaną użytkownika.
photoURL	ciąg | null	Adres URL nowego zdjęcia użytkowników. Ustaw null , aby wyczyścić istniejący adres URL zdjęcia użytkownika. Jeśli nie null , musi być prawidłowym adresem URL.
disabled	logiczna	Czy użytkownik jest wyłączony. true dla osób niepełnosprawnych; false dla włączonych.

Uwaga: Wszystkie powyższe właściwości są opcjonalne. Jeśli określona właściwość nie jest określona, ​​istniejąca wartość tej właściwości pozostaje niezmieniona.

Metoda update user zwraca zaktualizowany obiekt UserRecord po pomyślnym zakończeniu aktualizacji.

Jeśli podany uid użytkownika 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 zakończy się niepowodzeniem. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Usuń użytkownika

Pakiet Firebase Admin SDK umożliwia usuwanie istniejących użytkowników według ich uid :

Node.js

getAuth()
  .deleteUser(uid)
  .then(() => {
    console.log('Successfully deleted user');
  })
  .catch((error) => {
    console.log('Error deleting user:', error);
  });

Jawa

FirebaseAuth.getInstance().deleteUser(uid);
System.out.println("Successfully deleted user.");

Pyton

auth.delete_user(uid)
print('Successfully deleted user')

Iść

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, gdy usuwanie zakończy się pomyślnie.

Jeśli podany uid użytkownika nie odpowiada istniejącemu użytkownikowi lub użytkownika nie można usunąć z jakiegokolwiek innego powodu, metoda usuwania użytkownika zgłasza błąd. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Usuń wielu użytkowników

Pakiet Firebase Admin SDK może też usuwać wielu użytkowników jednocześnie. Należy jednak pamiętać, że użycie metod takich jak deleteUsers(uids) w celu usunięcia wielu użytkowników jednocześnie nie spowoduje wyzwolenia procedur obsługi zdarzeń onDelete() dla Cloud Functions for Firebase. Dzieje się tak, ponieważ usuwanie wsadowe nie wyzwala zdarzenia usunięcia użytkownika dla każdego użytkownika. Usuwaj użytkowników pojedynczo, jeśli chcesz, aby zdarzenia usuwania użytkowników były uruchamiane dla każdego usuniętego 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);
  });

Jawa

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

Pyton

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))

Iść

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 dla użytkowników, których nie udało się usunąć. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Wyświetl listę 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();

Jawa

// 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());
}

Pyton

# 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)

Iść

// 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 używany do wyświetlenia następnej partii użytkowników. Gdy wszyscy użytkownicy zostali już wymienieni, nie jest zwracany żaden pageToken .

Jeśli nie określono pola maxResults , używana jest domyślna liczba 1000 użytkowników na partię. Jest to również maksymalna liczba użytkowników, którzy mogą być wyświetlani jednocześnie. Każda wartość większa niż maksymalna spowoduje zgłoszenie błędu argumentu. Jeśli nie określono pageToken , operacja wyświetli listę użytkowników od początku, uporządkowaną według uid .

Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania problemów, zobacz Błędy interfejsu API uwierzytelniania administratora .

Skróty haseł wymienionych użytkowników

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

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

Aby utworzyć niestandardową rolę IAM:

1. Przejdź do strony Role w IAM i panelu administracyjnym w Google Cloud Console.
2. Wybierz swój projekt z listy rozwijanej 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. Kliknij UTWÓRZ , aby zakończyć tworzenie nowej roli.

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

1. W panelu IAM i administratora wybierz IAM
2. Wybierz usługę lub konto użytkownika z listy członków do edycji.
3. Kliknij DODAJ KOLEJNĄ ROLĘ .
4. Wyszukaj nową, wcześniej utworzoną rolę niestandardową.
5. Kliknij ZAPISZ .

Ostrzeżenie: nie używaj roli Editor jako środka dodawania uprawnienia firebaseauth.configs.getHashConfig . Ta potężna rola daje uprawnienia wykraczające poza zamierzony zakres.