管理使用者

Firebase Admin SDK 提供了一個 API,用於管理具有提升權限的 Firebase 驗證使用者。管理員使用者管理 API 可讓您在安全的伺服器環境中以程式設計方式完成以下任務:

  • 創建新用戶,沒有任何限製或速率限制。
  • 透過不同的標準(例如 uid、電子郵件或電話號碼)尋找使用者。
  • 批量列出指定項目的所有使用者。
  • 存取用戶元數據,包括帳戶建立日期和上次登入日期。
  • 刪除用戶而不需要其現有密碼。
  • 更新使用者屬性(包括密碼),而無需以使用者身分登入。
  • 驗證電子郵件,而無需透過帶外操作流程來驗證電子郵件。
  • 更改使用者的電子郵件而不發送電子郵件連結來撤銷這些變更。
  • 使用電話號碼建立新用戶,無需執行簡訊驗證流程。
  • 更改使用者的電話號碼,無需經過簡訊驗證流程。
  • 離線配置處於停用狀態的用戶,然後控制何時啟用它們。
  • 建立適合特定應用程式的使用者管理系統的自訂使用者控制台。

在你開始之前

若要使用 Firebase Admin SDK 提供的使用者管理 API,您必須擁有服務帳戶。請按照設定說明了解有關如何初始化 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);
  });

爪哇

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

Python

from firebase_admin import auth

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

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

此方法傳回與提供給該方法的uid相對應的使用者的UserRecord物件。

如果提供的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);
  });

爪哇

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

Python

from firebase_admin import auth

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

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 錯誤

在其他情況下,您將擁有用戶的電話號碼而不是他們的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);
  });

爪哇

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

Python

from firebase_admin import auth

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

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 錯誤

大量檢索使用者數據

Firebase Admin SDK 還允許根據您提供的識別碼檢索使用者清單。您可以透過使用者 ID、電子郵件或電話號碼來識別使用者。一次呼叫中最多可以提供 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);
  });

爪哇

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 錯誤

創建用戶

Admin SDK 提供了一種方法,可讓您建立新的 Firebase 驗證使用者。此方法接受包含要包含在新建立的使用者帳戶中的設定檔資訊的物件:

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

爪哇

CreateRequest request = new CreateRequest()
    .setEmail("user@example.com")
    .setEmailVerified(false)
    .setPassword("secretPassword")
    .setPhoneNumber("+11234567890")
    .setDisplayName("John Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(false);

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

Python

user = auth.create_user(
    email='user@example.com',
    email_verified=False,
    phone_number='+15555550100',
    password='secretPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=False)
print('Sucessfully created new user: {0}'.format(user.uid))

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 驗證將為新使用者產生隨機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);
  });

爪哇

CreateRequest request = new CreateRequest()
    .setUid("some-uid")
    .setEmail("user@example.com")
    .setPhoneNumber("+11234567890");

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

Python

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

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 個字元之間(含 1 和 128 個字元)。如果未提供,將自動產生隨機uid 。較短的uid提供更好的性能。
email細繩使用者的主要電子郵件。必須是一個有效的E-mail地址。
emailVerified布林值用戶的主要電子郵件是否經過驗證。如果未提供,則預設為false
phoneNumber細繩用戶的主要電話號碼。必須是符合 E.164 規範的有效電話號碼。
password細繩使用者的原始、未散列的密碼。長度必須至少為六個字元。
displayName細繩使用者的顯示名稱。
photoURL細繩使用者的照片 URL。
disabled布林值用戶是否已停用。對於殘疾人來說truefalse表示已啟用。如果未提供,則預設為false

使用者建立方法為新建立的使用者傳回一個UserRecord物件。

如果提供的uid 、電子郵件或電話號碼已被現有用戶使用,或因任何其他原因無法建立用戶,則上述方法將失敗並出現錯誤。有關錯誤代碼的完整清單(包括說明和解決步驟),請參閱管理驗證 API 錯誤

更新用戶

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

爪哇

UpdateRequest request = new UpdateRequest(uid)
    .setEmail("user@example.com")
    .setPhoneNumber("+11234567890")
    .setEmailVerified(true)
    .setPassword("newPassword")
    .setDisplayName("Jane Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(true);

UserRecord userRecord = FirebaseAuth.getInstance().updateUser(request);
System.out.println("Successfully updated user: " + userRecord.getUid());

Python

user = auth.update_user(
    uid,
    email='user@example.com',
    phone_number='+15555550100',
    email_verified=True,
    password='newPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=True)
print('Sucessfully updated user: {0}'.format(user.uid))

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細繩使用者的新主電子郵件。必須是一個有效的E-mail地址。
emailVerified布林值用戶的主要電子郵件是否經過驗證。如果未提供,則預設為false
phoneNumber細繩用戶的新主要電話號碼。必須是符合 E.164 規範的有效電話號碼。設定為null以清除使用者現有的電話號碼。
password細繩用戶的新的原始、未散列的密碼。長度必須至少為六個字元。
displayName字串| null使用者的新顯示名稱。設定為null以清除使用者現有的顯示名稱。
photoURL字串| null使用者的新照片 URL。設定為null以清除使用者現有的照片 URL。如果非null ,則必須是有效的 URL。
disabled布林值用戶是否已停用。對於殘疾人來說truefalse表示已啟用。

當更新成功完成時,更新使用者方法傳回更新的UserRecord物件。

如果提供的uid與現有用戶不對應,則提供的電子郵件或電話號碼已被現有用戶使用,或因任何其他原因無法更新用戶,則上述方法將失敗並出現錯誤。有關錯誤代碼的完整清單(包括說明和解決步驟),請參閱管理驗證 API 錯誤

刪除用戶

Firebase Admin SDK 允許透過使用者的uid刪除現有使用者:

Node.js

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

爪哇

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 錯誤

刪除多個用戶

Firebase Admin SDK 也可以一次刪除多個使用者。但請注意,使用deleteUsers(uids)等方法一次刪除多個使用者不會觸發 Cloud Functions for Firebase 的onDelete()事件處理程序。這是因為批量刪除不會對每個用戶觸發用戶刪除事件。如果您希望為每個已刪除的使用者觸發使用者刪除事件,請一次刪除一個使用者。

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

Python

from firebase_admin import auth

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

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

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 錯誤

列出所有用戶

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

爪哇

// 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 錯誤

列出用戶的密碼雜湊值

如果用於產生請求 OAuth 存取權杖的使用者/服務帳戶具有firebaseauth.configs.getHashConfig權限,此 API 也會傳回由 Firebase Auth 後端為密碼使用者散列的passwordSaltpasswordHash 。否則將不會設定passwordHashpasswordSalt

由於密碼雜湊的敏感性,Firebase Admin SDK 服務帳戶預設不具有firebaseauth.configs.getHashConfig權限。您無法直接向使用者/服務帳戶新增權限,但可以透過建立自訂 IAM 角色間接新增權限。

若要建立自訂 IAM 角色:

  1. 前往 Google Cloud 控制台IAM 和管理面板中的「角色」頁面。
  2. 從頁面頂部的下拉清單中選擇您的項目。
  3. 點擊創建角色
  4. 點擊新增權限
  5. 搜尋firebaseauth.configs.getHashConfig權限並選取該複選框。
  6. 點擊新增
  7. 點選“CREATE”完成新角色的建立。

在 IAM 頁面將建立的自訂角色新增至使用者/服務帳戶:

  1. IAM 和管理面板中,選擇IAM
  2. 從成員清單中選擇服務或使用者帳戶進行編輯。
  3. 點擊新增另一個角色
  4. 搜尋之前建立的新自訂角色。
  5. 按一下「儲存」