Управление пользователями

Firebase Admin SDK предоставляет API для управления пользователями Firebase Authentication с расширенными правами. API управления администратором позволяет программно выполнять следующие задачи из защищенной серверной среды:

  • Создавайте новых пользователей без каких-либо ограничений скорости или лимитов запросов.
  • Ищите пользователей по различным критериям, таким как UID, адрес электронной почты или номер телефона.
  • Вывести список всех пользователей указанного проекта партиями.
  • Получите доступ к метаданным пользователя, включая дату создания учетной записи и дату последнего входа в систему.
  • Удаление пользователей без запроса их существующих паролей.
  • Изменяйте свойства пользователя, включая его пароль, без необходимости входа в систему под этой учетной записью.
  • Проверяйте электронные письма без необходимости использования дополнительных процедур проверки, выполняемых вне системы.
  • Изменить адрес электронной почты пользователя без отправки электронных писем со ссылками для отмены этих изменений.
  • Создайте нового пользователя с номером телефона без необходимости проходить процедуру SMS-подтверждения.
  • Изменить номер телефона пользователя без необходимости прохождения SMS-подтверждения.
  • Предоставить пользователям доступ к сервису в автономном режиме, отключив их, а затем контролировать, когда их следует включить.
  • Создавайте пользовательские консоли, адаптированные под систему управления пользователями конкретного приложения.

Прежде чем начать

Для использования API управления пользователями, предоставляемого Firebase Admin SDK, вам необходима учетная запись службы. Следуйте инструкциям по настройке для получения дополнительной информации о том, как инициализировать Admin SDK.

Получение пользовательских данных

Основной способ идентификации пользователя — это его uid , уникальный идентификатор пользователя. Admin SDK предоставляет метод, позволяющий получать информацию о профиле пользователей по их 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);
  });

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUser(uid);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getUid());

Python

from firebase_admin import auth

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

Идти

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

Этот метод возвращает объект UserRecord для пользователя, соответствующего идентификатору пользователя uid , указанному в методе.

Если предоставленный uid не принадлежит существующему пользователю или пользователя не удается получить по какой-либо другой причине, описанный выше метод выдаст ошибку. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API аутентификации администратора» .

В некоторых случаях вместо uid пользователя может быть указан его адрес электронной почты. Firebase Admin SDK поддерживает поиск информации о пользователе по адресу электронной почты:

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

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUserByEmail(email);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getEmail());

Python

from firebase_admin import auth

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

Идти

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

Этот метод возвращает объект UserRecord содержащий имя пользователя, соответствующего указанному адресу электронной почты.

Если указанный адрес электронной почты не принадлежит существующему пользователю или пользователя не удается получить по какой-либо другой причине, Admin SDK выдает ошибку. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

В других случаях вместо uid пользователя будет указан его номер телефона. Firebase Admin SDK поддерживает поиск информации о пользователе по номеру телефона:

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

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUserByPhoneNumber(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getPhoneNumber());

Python

from firebase_admin import auth

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

Идти

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

Этот метод возвращает объект UserRecord содержащий имя пользователя, соответствующего указанному номеру телефона.

Если предоставленный номер телефона не принадлежит существующему пользователю или пользователя не удается получить по какой-либо другой причине, Admin SDK выдает ошибку. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Массовый сбор пользовательских данных

SDK Firebase Admin также позволяет получать список пользователей на основе предоставленных вами идентификаторов. Вы можете идентифицировать пользователей по их идентификатору пользователя, электронной почте или номеру телефона. В одном запросе можно указать максимум 100 идентификаторов. Идентификаторы могут содержать различные типы данных:

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

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)

Идти

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

Этот метод возвращает список того же размера, что и входной список, причем каждая запись содержит либо соответствующий UserRecord , либо ошибку, указывающую на причину, по которой этот идентификатор не удалось найти. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Создать пользователя

В Admin SDK есть метод, позволяющий создать нового пользователя Firebase Authentication . Этот метод принимает объект, содержащий информацию профиля, которая должна быть включена в созданную учетную запись пользователя:

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

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

Идти

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

По умолчанию Firebase Authentication генерирует случайный uid для нового пользователя. Если вы хотите указать свой собственный uid для нового пользователя, вы можете указать его в качестве аргумента, передаваемого методу создания пользователя:

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

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

Идти

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

Может быть предоставлена ​​любая комбинация следующих свойств:

Таблица 1. Свойства, поддерживаемые операцией создания пользователя.

Свойство Тип Описание
uid нить uid , присваиваемый новому пользователю. Должен представлять собой строку длиной от 1 до 128 символов включительно. Если не указан, будет автоматически сгенерирован случайный uid . Более короткие uid обеспечивают лучшую производительность.
email нить Основной адрес электронной почты пользователя. Должен быть действительным адресом электронной почты.
emailVerified логический Указывает, подтвержден ли основной адрес электронной почты пользователя. Если не указан, по умолчанию — false .
phoneNumber нить Основной номер телефона пользователя. Должен быть действительным номером телефона, соответствующим стандарту E.164.
password нить Нехешированный пароль пользователя. Должен содержать не менее шести символов.
displayName нить Отображаемое имя пользователя.
photoURL нить URL-адрес фотографии пользователя.
disabled логический Указывает, отключен ли пользователь. true для отключенного пользователя; false для включенного. Если значение не указано, по умолчанию используется false .

Метод создания пользователя возвращает объект UserRecord для вновь созданного пользователя.

Если предоставленный uid , адрес электронной почты или номер телефона уже используется существующим пользователем или если создание пользователя невозможно по какой-либо другой причине, описанный выше метод завершится ошибкой. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Обновить данные пользователя

Firebase Admin SDK упрощает изменение данных существующего пользователя. Вам необходимо указать uid вместе со свойствами, которые нужно обновить для этого пользователя:

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

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

Идти

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

Может быть предоставлена ​​любая комбинация следующих свойств:

Таблица 2. Свойства, поддерживаемые операцией обновления пользователя.

Свойство Тип Описание
email нить Новый основной адрес электронной почты пользователя. Должен быть действительный адрес электронной почты.
emailVerified логический Указывает, подтвержден ли основной адрес электронной почты пользователя. Если не указан, по умолчанию — false .
phoneNumber строка | null Новый основной номер телефона пользователя. Должен соответствовать требованиям стандарта E.164. Установите значение null , чтобы удалить существующий номер телефона пользователя.
password нить Новый, нехешированный пароль пользователя. Должен содержать не менее шести символов.
displayName строка | null Новое отображаемое имя пользователя. Установите значение null , чтобы удалить существующее отображаемое имя пользователя.
photoURL строка | null Новый URL-адрес фотографии пользователя. Установите значение null , чтобы удалить существующий URL-адрес фотографии пользователя. Если значение не равно null , это должен быть действительный URL-адрес.
disabled логический Определяет, отключен ли пользователь. true для отключенного пользователя; false для включенного пользователя.

Метод обновления пользователя возвращает обновленный объект UserRecord после успешного завершения обновления.

Если предоставленный uid не соответствует существующему пользователю, предоставленный адрес электронной почты или номер телефона уже используется существующим пользователем, или пользователя невозможно обновить по какой-либо другой причине, описанный выше метод завершится ошибкой. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Удалить пользователя

Firebase Admin SDK позволяет удалять существующих пользователей по их uid :

Node.js

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

Java

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

Python

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

Идти

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

Метод удаления пользователя возвращает пустой результат, если удаление завершилось успешно.

Если предоставленный uid не соответствует существующему пользователю или пользователя невозможно удалить по какой-либо другой причине, метод удаления пользователя выдаст ошибку. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Удаление нескольких пользователей

SDK Firebase Admin также позволяет удалять нескольких пользователей одновременно. Однако следует отметить, что использование таких методов, как deleteUsers(uids) для одновременного удаления нескольких пользователей не вызовет обработчики событий onDelete() для Cloud Functions for Firebase . Это связано с тем, что пакетное удаление не запускает событие удаления для каждого пользователя отдельно. Удаляйте пользователей по одному, если хотите, чтобы события удаления срабатывали для каждого удаленного пользователя.

Node.js

getAuth()
  .deleteUsers([uid1, uid2, uid3])
  .then((deleteUsersResult) => {
    console.log(`Successfully deleted ${deleteUsersResult.successCount} users`);
    console.log(`Failed to delete ${deleteUsersResult.failureCount} users`);
    deleteUsersResult.errors.forEach((err) => {
      console.log(err.error.toJSON());
    });
  })
  .catch((error) => {
    console.log('Error deleting users:', error);
  });

Java

DeleteUsersResult result = FirebaseAuth.getInstance().deleteUsersAsync(
    Arrays.asList("uid1", "uid2", "uid3")).get();

System.out.println("Successfully deleted " + result.getSuccessCount() + " users");
System.out.println("Failed to delete " + result.getFailureCount() + " users");
for (ErrorInfo error : result.getErrors()) {
  System.out.println("error #" + error.getIndex() + ", reason: " + error.getReason());
}

Python

from firebase_admin import auth

result = auth.delete_users(["uid1", "uid2", "uid3"])

print(f'Successfully deleted {result.success_count} users')
print(f'Failed to delete {result.failure_count} users')
for err in result.errors:
    print(f'error #{result.index}, reason: {result.reason}')

Идти

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

Метод удаления пользователей возвращает список ошибок для пользователей, которых не удалось удалить. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Список всех пользователей

Firebase Admin SDK позволяет получать полный список пользователей пакетами:

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

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)

Идти

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

Каждая группа результатов содержит список пользователей и токен следующей страницы, используемый для отображения следующей группы пользователей. Если все пользователи уже отображены, pageToken не возвращается.

Если поле maxResults не указано, используется значение по умолчанию — 1000 пользователей за пакет. Это также максимальное количество пользователей, которое может быть отображено одновременно. Любое значение, превышающее максимальное, вызовет ошибку аргумента. Если pageToken не указан, операция будет отображать пользователей с начала, упорядоченных по uid .

Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки API Authentication администратора» .

Хэши паролей перечисленных пользователей

Этот API также возвращает passwordSalt и passwordHash хешированные бэкэндом Firebase Auth для пользователей с паролем, если учетная запись пользователя/службы, использованная для генерации токена доступа OAuth для запроса, имеет разрешение firebaseauth.configs.getHashConfig . В противном случае passwordHash и passwordSalt не будут установлены.

Из-за конфиденциальности хэшей паролей учетная запись службы Firebase Admin SDK по умолчанию не имеет разрешения firebaseauth.configs.getHashConfig . Вы не можете добавить разрешение непосредственно к учетной записи пользователя/службы, но можете сделать это косвенно, создав пользовательскую роль IAM .

Для создания пользовательской роли IAM:

  1. Перейдите на страницу «Роли» в панели управления IAM и администратора в консоли Google Cloud .
  2. Выберите свой проект из выпадающего списка в верхней части страницы.
  3. Нажмите «СОЗДАТЬ РОЛЬ» .
  4. Нажмите «ДОБАВИТЬ РАЗРЕШЕНИЯ».
  5. Найдите разрешение firebaseauth.configs.getHashConfig и установите флажок напротив него.
  6. Нажмите ДОБАВИТЬ
  7. Нажмите «СОЗДАТЬ» , чтобы завершить создание новой роли.

Добавьте созданную пользовательскую роль к учетной записи пользователя/службы на странице IAM:

  1. В панели управления IAM и администрирования выберите IAM .
  2. Выберите сервис или учетную запись пользователя из списка участников для редактирования.
  3. Нажмите «ДОБАВИТЬ ЕЩЕ ОДНУ РОЛЬ» .
  4. Найдите созданную ранее пользовательскую роль.
  5. Нажмите СОХРАНИТЬ .