了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

本頁面由 Cloud Translation API 翻譯而成。

管理使用者

Firebase Admin SDK 提供的 API 可讓您以進階權限管理 Firebase 驗證使用者。admin user Management API 可讓您透過程式在安全的伺服器環境中完成下列工作：

建立新使用者，而不設下任何節流限製或頻率限制。
根據不同的條件 (例如 uid、電子郵件或電話號碼) 查詢使用者。
批次列出指定專案的所有使用者。
存取使用者中繼資料，包括帳戶建立日期和上次登入日期。
不必提供現有密碼即可刪除使用者。
更新使用者屬性 (包括密碼)，而無需以使用者身分登入。
不必完成頻外動作流程來驗證電子郵件，就能直接驗證電子郵件。
變更使用者的電子郵件，但不傳送電子郵件連結，藉此撤銷這些變更。
使用電話號碼建立新使用者，無須完成簡訊驗證流程。
不必完成簡訊驗證流程就能變更使用者的電話號碼。
離線佈建使用者處於停用狀態，之後又控管何時啟用離線佈建功能。
建構專為特定應用程式的使用者管理系統量身打造的自訂使用者主控台。

事前準備

如要使用 Firebase Admin SDK 提供的使用者管理 API，您必須擁有服務帳戶。請按照設定操作說明，進一步瞭解如何初始化 Admin SDK。

擷取使用者資料

識別使用者的主要方式是其 uid，也就是該使用者的專屬 ID。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

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

Go

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

u, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatalf("error getting user %s: %v\n", uid, err)
}
log.Printf("Successfully fetched user data: %v\n", u)auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

這個方法會針對提供給該方法的 uid 對應的使用者，傳回 UserRecord 物件。

如果提供的 uid 不屬於現有使用者，或因任何其他原因而無法擷取使用者，則上述方法會擲回錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Auth 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

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

Go

u, err := client.GetUserByEmail(ctx, email)
if err != nil {
	log.Fatalf("error getting user by email %s: %v\n", email, err)
}
log.Printf("Successfully fetched user data: %v\n", u)auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

這個方法會針對所提供電子郵件對應的使用者傳回 UserRecord 物件。

如果提供的電子郵件不屬於現有使用者，或因其他原因而無法擷取使用者，Admin SDK 就會擲回錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication 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);
  });manage_users.js

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

Go

u, err := client.GetUserByPhoneNumber(ctx, phone)
if err != nil {
	log.Fatalf("error getting user by phone %s: %v\n", phone, err)
}
log.Printf("Successfully fetched user data: %v\n", u)auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

這個方法會針對提供的電話號碼對應使用者傳回 UserRecord 物件。

如果提供的電話號碼不屬於現有使用者，或因其他原因而無法擷取使用者，Admin SDK 會擲回錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication API 錯誤。

大量擷取使用者資料

Firebase Admin SDK 也可讓您根據您提供的 ID 擷取使用者清單。您可透過使用者 ID、電子郵件或電話號碼識別使用者。單次呼叫最多可提供 100 個 ID。ID 可包含多種類型：

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

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)

Go

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，或是錯誤指出無法查詢該 ID 的原因。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication 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);
  });manage_users.js

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

Go

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

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

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

Go

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

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`	字串	使用者未經雜湊處理的原始密碼。長度不得少於 6 個字元。
`displayName`	字串	使用者的顯示名稱。
`photoURL`	字串	使用者的相片網址。
`disabled`	布林值	使用者是否停用。`true` 代表已停用，`false` 代表已啟用。如未提供，則預設值為 `false`。

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

如果提供的 uid、電子郵件地址或電話號碼已有人使用，或是基於其他原因而無法建立該使用者，上述方法就會失敗並產生錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱「Admin Authentication 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);
  });manage_users.js

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

Go

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

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`	字串	使用者的新主要電話號碼。必須是符合 E.164 規格的有效電話號碼。設為 `null` 即可清除使用者現有的電話號碼。
`password`	字串	使用者的新未雜湊處理原始密碼。長度不得少於 6 個字元。
`displayName`	字串 \| `null`	使用者的新顯示名稱。設為 `null` 即可清除使用者現有的顯示名稱。
`photoURL`	字串 \| `null`	使用者的新相片網址。設為 `null` 即可清除使用者現有的相片網址。如果非 `null`，則必須提供有效的網址。
`disabled`	布林值	使用者是否停用。`true` 代表已停用，`false` 代表已啟用。

更新使用者方法會在更新成功完成時傳回更新後的 UserRecord 物件。

如果提供的 uid 未對應至現有使用者、目前使用者已有使用提供的電子郵件地址或電話號碼，或者使用者基於任何其他原因而無法更新，上述方法就會失敗並產生錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication API 錯誤。

刪除使用者

您可以透過 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

Java

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

Python

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

Go

err := client.DeleteUser(ctx, uid)
if err != nil {
	log.Fatalf("error deleting user: %v\n", err)
}
log.Printf("Successfully deleted user: %s\n", uid)auth.go

C#

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

當刪除成功完成時，刪除使用者方法會傳回空白結果。

如果提供的 uid 未對應至現有使用者，或使用者因其他原因而無法刪除，刪除使用者方法會擲回錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication 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);
  });

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

Go

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

刪除使用者方法會傳回無法刪除使用者失敗的清單。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication 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();manage_users.js

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)

Go

// Note, behind the scenes, the Users() iterator will retrive 1000 Users at a time through the API
iter := client.Users(ctx, "")
for {
	user, err := iter.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		log.Fatalf("error listing users: %s\n", err)
	}
	log.Printf("read user user: %v\n", user)
}

// Iterating by pages 100 users at a time.
// Note that using both the Next() function on an iterator and the NextPage()
// on a Pager wrapping that same iterator will result in an error.
pager := iterator.NewPager(client.Users(ctx, ""), 100, "")
for {
	var users []*auth.ExportedUserRecord
	nextPageToken, err := pager.NextPage(&users)
	if err != nil {
		log.Fatalf("paging error %v\n", err)
	}
	for _, u := range users {
		log.Printf("read user user: %v\n", u)
	}
	if nextPageToken == "" {
		break
	}
}auth.go

C#

// Start listing users from the beginning, 1000 at a time.
var pagedEnumerable = FirebaseAuth.DefaultInstance.ListUsersAsync(null);
var responses = pagedEnumerable.AsRawResponses().GetAsyncEnumerator();
while (await responses.MoveNextAsync())
{
    ExportedUserRecords response = responses.Current;
    foreach (ExportedUserRecord user in response.Users)
    {
        Console.WriteLine($"User: {user.Uid}");
    }
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
var enumerator = FirebaseAuth.DefaultInstance.ListUsersAsync(null).GetAsyncEnumerator();
while (await enumerator.MoveNextAsync())
{
    ExportedUserRecord user = enumerator.Current;
    Console.WriteLine($"User: {user.Uid}");
}

每批結果都包含使用者清單，以及用來列出下一批使用者的下一頁憑證。如果列出了所有使用者，就不會傳回 pageToken。

如未指定 maxResults 欄位，系統會使用每批次預設的 1000 位使用者。這也是一次允許列出的使用者人數上限。任何大於最大值的值都會擲回引數錯誤。如未指定 pageToken，作業會從開頭列出使用者，並依 uid 排序。

如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱 Admin Authentication API 錯誤。

所列使用者的密碼雜湊

如果用來產生要求 OAuth 存取權杖的使用者/服務帳戶擁有 firebaseauth.configs.getHashConfig 權限，這個 API 也會傳回 Firebase 驗證後端為密碼使用者雜湊的 passwordSalt 和 passwordHash。否則，系統不會設定 passwordHash 和 passwordSalt。

由於密碼雜湊具有敏感性質，因此 Firebase Admin SDK 服務帳戶預設不具備 firebaseauth.configs.getHashConfig 權限。您無法直接為使用者/服務帳戶新增權限，但可以建立自訂 IAM 角色間接執行這項操作。

如要建立自訂 IAM 角色：

前往 Google Cloud 控制台中「IAM 與管理」面板中的「角色」頁面。
在頁面頂端的下拉式選單中選取專案。
按一下「建立角色」
按一下「新增權限」
搜尋 firebaseauth.configs.getHashConfig 權限並選取該核取方塊。
點選「新增」。
按一下「建立」完成新角色建立程序。

在「IAM」頁面中，將建立的自訂角色新增到使用者/服務帳戶：

在「IAM 與管理」面板中，選取「身分與存取權管理」
從成員清單中選取服務或使用者帳戶。
按一下「新增其他角色」。
搜尋先前建立的新自訂角色。
點選「儲存」。