Zarządzanie użytkownikami

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

  • Twórz nowych użytkowników bez ograniczania przepustowości.
  • Wyszukaj użytkowników według różnych kryteriów, takich jak UID, adres e-mail lub numer telefonu.
  • Wyświetl listę wszystkich użytkowników określonego projektu partiami.
  • 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 pozapasmowych działań mających na celu weryfikację wiadomości e-mail.
  • Aby cofnąć te zmiany, zmień adres e-mail użytkownika bez wysyłania łączy e-mailowych.
  • 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 przeprowadzania weryfikacji SMS-em.
  • Przydzielaj użytkownikom usługi offline w stanie wyłączonym, a później kontroluj, kiedy je włączyć.
  • Twórz niestandardowe konsole użytkownika, które są 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. Postępuj zgodnie z instrukcjami instalacji , aby uzyskać więcej informacji na temat inicjowania pakietu Admin SDK.

Odzyskaj dane użytkownika

Podstawowym sposobem identyfikacji użytkownika jest jego uid , unikalny identyfikator tego użytkownika. Admin SDK udostępnia metodę umożliwiającą pobieranie informacji o profilu 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)

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 przekazanemu metodzie.

Jeśli podany uid nie należy do istniejącego użytkownika lub użytkownik nie może zostać pobrany z innego powodu, powyższa metoda zgłosi błąd. Pełną listę kodów błędów, w tym opisy i kroki rozwiązywania, znajdziesz w artykule Błędy interfejsu API uwierzytelniania administratora .

W niektórych przypadkach zamiast uid uid będzie widoczny adres e-mail użytkownika. Pakiet Firebase Admin SDK obsługuje wyszukiwanie informacji o użytkowniku 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)

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ący podanemu adresowi e-mail.

Jeśli podany adres e-mail nie należy do istniejącego użytkownika lub użytkownika nie można pobrać z 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, zobacz Błędy interfejsu API uwierzytelniania administratora .

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

Node.js

getAuth()
  .getUserByPhoneNumber(phoneNumber)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data:  ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });

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)

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 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, zobacz Błędy interfejsu API uwierzytelniania administratora .

Zbiorcze pobieranie danych użytkownika

Pakiet Firebase Admin SDK umożliwia także pobieranie listy użytkowników na podstawie podanych przez Ciebie identyfikatorów. Możesz identyfikować użytkowników po ich identyfikatorze, adresie e-mail lub numerze telefonu. W jednym wywołaniu można podać maksymalnie 100 identyfikatorów. Identyfikatory mogą zawierać mieszankę typó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);
  });

Jawa

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

Pyton

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)

Iść

getUsersResult, err := client.GetUsers(ctx, []auth.UserIdentifier{
	auth.UIDIdentifier{UID: "uid1"},
	auth.EmailIdentifier{Email: "user@example.com"},
	auth.PhoneIdentifier{PhoneNumber: "+15555551234"},
	auth.ProviderIdentifier{ProviderID: "google.com", ProviderUID: "google_uid1"},
})
if err != nil {
	log.Fatalf("error retriving multiple users: %v\n", err)
}

log.Printf("Successfully fetched user data:")
for _, u := range getUsersResult.Users {
	log.Printf("%v", u)
}

log.Printf("Unable to find users corresponding to these identifiers:")
for _, id := range getUsersResult.NotFound {
	log.Printf("%v", id)
}

C#

GetUsersResult result = await FirebaseAuth.DefaultInstance.GetUsersAsync(
    new List<UserIdentifier>
    {
        new UidIdentifier("uid1"),
        new EmailIdentifier("user2@example.com"),
        new PhoneIdentifier("+15555550003"),
        new ProviderIdentifier("google.com", "google_uid4"),
    });

Console.WriteLine("Successfully fetched user data:");
foreach (UserRecord user in result.Users)
{
    Console.WriteLine($"User: {user.Uid}");
}

Console.WriteLine("Unable to find users corresponding to these identifiers:");
foreach (UserIdentifier uid in result.NotFound)
{
    Console.WriteLine($"{uid}");
}

Ta metoda zwraca listę o tym samym rozmiarze co lista wejściowa, przy czym każdy wpis zawiera albo odpowiedni UserRecord , albo 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, zobacz Błędy interfejsu API uwierzytelniania administratora .

Utwórz użytkownika

Pakiet Admin SDK udostępnia metodę umożliwiającą utworzenie nowego użytkownika uwierzytelniania Firebase. Ta metoda akceptuje obiekt zawierający informacje o profilu, który należy uwzględnić w 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);
  });

Jawa

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

Pyton

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

Iść

params := (&auth.UserToCreate{}).
	Email("user@example.com").
	EmailVerified(false).
	PhoneNumber("+15555550100").
	Password("secretPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(false)
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)

C#

UserRecordArgs args = new UserRecordArgs()
{
    Email = "user@example.com",
    EmailVerified = false,
    PhoneNumber = "+11234567890",
    Password = "secretPassword",
    DisplayName = "John Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = false,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

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

Jawa

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

Pyton

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

Iść

params := (&auth.UserToCreate{}).
	UID(uid).
	Email("user@example.com").
	PhoneNumber("+15555550100")
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)

C#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = "some-uid",
    Email = "user@example.com",
    PhoneNumber = "+11234567890",
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

Można zapewnić dowolną kombinację następujących właściwości:

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

Nieruchomość Typ Opis
uid strunowy uid który ma zostać przypisany 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 zostanie podany, losowy uid zostanie wygenerowany automatycznie. Krótsze uid zapewniają lepszą wydajność.
email strunowy Główny adres e-mail użytkownika. Musi to być prawidłowy adres e-mail.
emailVerified wartość logiczna Określa, czy główny adres e-mail użytkownika został zweryfikowany. Jeśli nie zostanie podany, wartością domyślną jest false .
phoneNumber strunowy Główny 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 Wyświetlana nazwa użytkownika.
photoURL strunowy Adres URL zdjęcia użytkownika.
disabled wartość logiczna Określa, czy użytkownik jest wyłączony. true dla osób niepełnosprawnych; false dla włączonego. Jeśli nie zostanie podany, wartością domyślną jest false .

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

Jeżeli podany uid , adres e-mail lub numer telefonu jest już używany przez istniejącego użytkownika lub użytkownik nie może zostać utworzony z innego powodu, powyższa metoda zakończy się niepowodzeniem i wystąpieniem błędu. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania, 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 wraz z właściwościami do aktualizacji dla tego użytkownika:

Node.js

getAuth()
  .updateUser(uid, {
    email: 'modifiedUser@example.com',
    phoneNumber: '+11234567890',
    emailVerified: true,
    password: 'newPassword',
    displayName: 'Jane Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: true,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully updated user', userRecord.toJSON());
  })
  .catch((error) => {
    console.log('Error updating user:', error);
  });

Jawa

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

Pyton

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

Iść

params := (&auth.UserToUpdate{}).
	Email("user@example.com").
	EmailVerified(true).
	PhoneNumber("+15555550100").
	Password("newPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(true)
u, err := client.UpdateUser(ctx, uid, params)
if err != nil {
	log.Fatalf("error updating user: %v\n", err)
}
log.Printf("Successfully updated user: %v\n", u)

C#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = uid,
    Email = "modifiedUser@example.com",
    PhoneNumber = "+11234567890",
    EmailVerified = true,
    Password = "newPassword",
    DisplayName = "Jane Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = true,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.UpdateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully updated user: {userRecord.Uid}");

Można zapewnić dowolną kombinację następujących właściwości:

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

Nieruchomość Typ Opis
email strunowy Nowy podstawowy adres e-mail użytkownika. Musi to być prawidłowy adres e-mail.
emailVerified wartość logiczna Określa, czy główny adres e-mail użytkownika został zweryfikowany. Jeśli nie zostanie podany, wartością domyślną jest false .
phoneNumber strunowy Nowy główny numer telefonu użytkownika. Musi to być prawidłowy numer telefonu zgodny ze specyfikacją E.164. Ustaw na 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 wyświetlana nazwa użytkownika. Ustaw na null , aby wyczyścić istniejącą nazwę wyświetlaną użytkownika.
photoURL ciąg | null Nowy adres URL zdjęcia użytkowników. Ustaw na null , aby wyczyścić istniejący adres URL zdjęcia użytkownika. Jeśli wartość jest różna od null , musi to być prawidłowy adres URL.
disabled wartość logiczna Określa, czy użytkownik jest wyłączony. true dla osób niepełnosprawnych; false dla włączonego.

Metoda użytkownika update zwraca zaktualizowany obiekt UserRecord po pomyślnym zakończeniu aktualizacji.

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 lub użytkownik nie może zostać zaktualizowany z innego powodu, powyższa metoda zakończy się niepowodzeniem i wystąpieniem błędu. Aby uzyskać pełną listę kodów błędów, w tym opisy i kroki rozwiązywania, zobacz Błędy interfejsu API uwierzytelniania administratora .

Usuń użytkownika

Pakiet SDK administratora Firebase 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)

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 nie odpowiada istniejącemu użytkownikowi lub użytkownik nie może zostać usunięty z 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, zobacz Błędy interfejsu API uwierzytelniania administratora .

Usuń wielu użytkowników

Pakiet SDK administratora Firebase może także usuwać wielu użytkowników jednocześnie. Należy jednak pamiętać, że użycie metod takich jak deleteUsers(uids) do jednoczesnego usunięcia wielu użytkowników nie spowoduje uruchomienia procedur obsługi zdarzeń onDelete() dla Cloud Functions dla Firebase. Dzieje się tak, ponieważ usuwanie zbiorcze nie wyzwala zdarzenia usunięcia użytkownika dla każdego użytkownika. Usuń użytkowników pojedynczo, jeśli chcesz, aby zdarzenia usunięcia użytkownika 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 usuwania użytkowników zwraca listę niepowodzeń 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, zobacz Błędy interfejsu API uwierzytelniania administratora .

Lista wszystkich użytkowników

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

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

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 kolejnej partii użytkowników. Gdy wszyscy użytkownicy zostali już uwzględnieni, nie jest zwracany żaden pageToken .

Jeśli nie określono żadnego pola maxResults , zostanie użyte domyślne 1000 użytkowników na partię. Jest to również maksymalna liczba użytkowników, których można jednocześnie umieścić na liście. Każda wartość większa niż maksymalna spowoduje zgłoszenie błędu argumentu. Jeżeli nie określono żadnego 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, zobacz Błędy interfejsu API uwierzytelniania administratora .

Skróty haseł wymienionych użytkowników

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

Ze względu na wrażliwy 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ę uprawnień .

Aby utworzyć niestandardową rolę uprawnień:

  1. Przejdź do strony Role w panelu Uprawnienia i administrator w konsoli Google Cloud.
  2. Wybierz swój projekt z menu rozwijanego 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ą rolę niestandardową do konta użytkownika/usługi na stronie IAM:

  1. W panelu Uprawnienia i panel administracyjny wybierz opcję Uprawnienia
  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 .