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

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

Ява

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

Питон

from firebase_admin import auth

user = auth.get_user(uid)
print('Successfully fetched user data: {0}'.format(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)
auth.go

С#

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

Ява

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

Питон

from firebase_admin import auth

user = auth.get_user_by_email(email)
print('Successfully fetched user data: {0}'.format(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)
auth.go

С#

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 администратора» .

Предупреждение. Для поиска электронной почты вы можете искать только основной адрес электронной почты (верхнего уровня), а не электронные письма конкретного поставщика. Например, если учетная запись Facebook с другим адресом электронной почты [e-mail] связана с существующим пользователем с адресом электронной почты [e-mail] , вызов getUserByEmail("[e-mail]") не даст результатов, тогда как getUserByEmail("[e-mail]") вернет ожидаемого пользователя. В случае настройки по умолчанию «одна учетная запись для каждого адреса электронной почты» первый адрес электронной почты, используемый для входа в систему, будет использоваться в качестве адреса электронной почты верхнего уровня, если он не будет изменен впоследствии. Если установлено «несколько учетных записей на один адрес электронной почты», основной адрес электронной почты задается только при создании пароля пользователя, если он не обновлен вручную.

В других случаях у вас будет номер телефона пользователя вместо его 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);
  });
manage_users.js

Ява

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

Питон

from firebase_admin import auth

user = auth.get_user_by_phone_number(phone)
print('Successfully fetched user data: {0}'.format(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)
auth.go

С#

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 администратора» .

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

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

Node.js

getAuth()
  .getUsers([
    { uid: 'uid1' },
    { email: '[e-mail]' },
    { phoneNumber: '[phone]' },
    { providerId: 'google.com', providerUid: 'google_uid4' },
  ])
  .then((getUsersResult) => {
    console.log('Successfully fetched user data:');
    getUsersResult.users.forEach((userRecord) => {
      console.log(userRecord);
    });

    console.log('Unable to find users corresponding to these identifiers:');
    getUsersResult.notFound.forEach((userIdentifier) => {
      console.log(userIdentifier);
    });
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Ява

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

Питон

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)

Идти

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

С#

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

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

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

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

Node.js

getAuth()
  .createUser({
    email: '[e-mail]',
    emailVerified: false,
    phoneNumber: '[phone]',
    password: 'secretPassword',
    displayName: 'John Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: false,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });
manage_users.js

Ява

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

Питон

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

Идти

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

С#

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

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

Node.js

getAuth()
  .createUser({
    uid: 'some-uid',
    email: '[e-mail]',
    phoneNumber: '[phone]',
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });
manage_users.js

Ява

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

Питон

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

Идти

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

С#

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

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

Таблица 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: '[e-mail]',
    phoneNumber: '[phone]',
    emailVerified: true,
    password: 'newPassword',
    displayName: 'Jane Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: true,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully updated user', userRecord.toJSON());
  })
  .catch((error) => {
    console.log('Error updating user:', error);
  });
manage_users.js

Ява

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

Питон

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

Идти

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

С#

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

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

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

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

Примечание. Все вышеперечисленные свойства являются необязательными. Если определенное свойство не указано, существующее значение этого свойства остается неизменным.

Пользовательский метод update возвращает обновленный объект 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);
  });
manage_users.js

Ява

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

Питон

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

С#

await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid);
Console.WriteLine("Successfully deleted user.");

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

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

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

Firebase Admin SDK также может удалять несколько пользователей одновременно. Однако обратите внимание, что использование таких методов, как 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);
  });

Ява

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

Питон

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

Идти

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

С#

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

Ява

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

Питон

# 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
	}
}
auth.go

С#

// 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. Нажмите СОХРАНИТЬ .

Предупреждение. Не используйте роль Editor как средство добавления разрешения firebaseauth.configs.getHashConfig . Эта мощная роль дает разрешения, выходящие за рамки предполагаемого объема.