Firebase Summit で発表されたすべての情報をご覧ください。Firebase を使用してアプリ開発を加速し、自信を持ってアプリを実行する方法を紹介しています。詳細

ユーザーの管理

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Firebase Admin SDKは、昇格された権限を持つFirebaseAuthenticationユーザーを管理するためのAPIを提供します。管理者ユーザー管理APIを使用すると、安全なサーバー環境から次のタスクをプログラムで完了することができます。

  • スロットルやレート制限なしで新しいユーザーを作成します。
  • uid、電子メール、電話番号などのさまざまな基準でユーザーを検索します。
  • 指定したプロジェクトのすべてのユーザーをバッチで一覧表示します。
  • アカウントの作成日や最終ログイン日などのユーザーメタデータにアクセスします。
  • 既存のパスワードを必要とせずにユーザーを削除します。
  • ユーザーとしてサインインしなくても、ユーザーのプロパティ(パスワードを含む)を更新します。
  • 電子メールを検証するための帯域外アクションフローを実行することなく、電子メールを検証します。
  • これらの変更を取り消すために電子メールリンクを送信せずにユーザーの電子メールを変更します。
  • SMS検証フローを実行せずに、電話番号を使用して新しいユーザーを作成します。
  • SMS検証フローを経由せずに、ユーザーの電話番号を変更します。
  • 無効状態のユーザーをオフラインでプロビジョニングし、後でそれらを有効にするタイミングを制御します。
  • 特定のアプリケーションのユーザー管理システムに合わせて調整されたカスタムユーザーコンソールを構築します。

あなたが始める前に

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

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

行け

// 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が既存のユーザーに属していない場合、または他の理由でユーザーをフェッチできない場合、上記のメソッドはエラーをスローします。説明と解決手順を含むエラーコードの完全なリストについては、 Admin AuthAPIエラーを参照してください。

場合によっては、 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('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オブジェクトを返します。

提供された電子メールが既存のユーザーに属していない場合、または他の理由でユーザーを取得できない場合、AdminSDKはエラーをスローします。説明と解決手順を含むエラーコードの完全なリストについては、管理者認証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);
  });

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

行け

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オブジェクトを返します。

指定された電話番号が既存のユーザーに属していない場合、またはその他の理由でユーザーを取得できない場合、AdminSDKはエラーをスローします。説明と解決手順を含むエラーコードの完全なリストについては、管理者認証APIエラーを参照してください。

ユーザーデータの一括取得

Firebase Admin SDKでは、指定した識別子に基づいてユーザーのリストを取得することもできます。ユーザーは、ユーザーID、電子メール、または電話番号で識別できます。 1回の呼び出しで最大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エラーを参照してください。

ユーザーを作成する

Admin SDKは、新しいFirebaseAuthenticationユーザーを作成できるメソッドを提供します。このメソッドは、新しく作成されたユーザーアカウントに含めるプロファイル情報を含むオブジェクトを受け入れます。

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

デフォルトでは、FirebaseAuthenticationは新しいユーザーのランダムな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('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文字の長さの文字列である必要があります。指定しない場合、ランダムなuidが自動的に生成されます。
emailストリングユーザーのメインの電子メール。有効な電子メールアドレスでなければなりません。
emailVerifiedブール値ユーザーのメインの電子メールが確認されているかどうか。指定しない場合、デフォルトはfalseです。
phoneNumberストリングユーザーのメインの電話番号。有効なE.164仕様に準拠した電話番号である必要があります。
passwordストリングユーザーの生のハッシュされていないパスワード。 6文字以上の長さである必要があります。
displayNameストリングユーザーの表示名。
photoURLストリングユーザーの写真のURL。
disabledブール値ユーザーが無効になっているかどうか。障害者の場合はtrue 。有効の場合はfalse 。指定しない場合、デフォルトは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);
  });

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

行け

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ストリングユーザーの新しい主要電話番号。有効なE.164仕様に準拠した電話番号である必要があります。ユーザーの既存の電話番号をクリアするには、 nullに設定します。
passwordストリングユーザーの新しい生のハッシュされていないパスワード。 6文字以上の長さである必要があります。
displayName文字列| nullユーザーの新しい表示名。ユーザーの既存の表示名をクリアするには、 nullに設定します。
photoURL文字列| nullユーザーの新しい写真のURL。ユーザーの既存の写真のURLをクリアするには、 nullに設定します。 null以外の場合は、有効なURLである必要があります。
disabledブール値ユーザーが無効になっているかどうか。障害者の場合はtrue 。有効の場合はfalse

update userメソッドは、更新が正常に完了すると、更新された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);
  });

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

削除が正常に完了すると、deleteuserメソッドは空の結果を返します。

指定されたuidが既存のユーザーに対応していない場合、または他の理由でユーザーを削除できない場合、deleteuserメソッドはエラーをスローします。説明と解決手順を含むエラーコードの完全なリストについては、管理者認証APIエラーを参照してください。

複数のユーザーを削除する

Firebase Admin SDKは、一度に複数のユーザーを削除することもできます。ただし、 deleteUsers(uids)などのメソッドを使用して複数のユーザーを一度に削除しても、Cloud Functions for FirebaseのonDelete()イベントハンドラーはトリガーされないことに注意してください。これは、バッチ削除が各ユーザーのユーザー削除イベントをトリガーしないためです。削除されたユーザーごとにユーザー削除イベントを発生させる場合は、ユーザーを1つずつ削除します。

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

行け

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

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エラーを参照してください。

リストされたユーザーのパスワードハッシュ

このAPIは、リクエストOAuthアクセストークンの生成に使用されたユーザー/サービスアカウントにfirebaseauth.configs.getHashConfig権限がある場合、パスワードユーザーのFirebaseAuthバックエンドによってハッシュされたpasswordSaltpasswordHashも返します。そうしないと、 passwordHashpasswordSaltが設定されません。

パスワードハッシュの機密性のため、Firebase AdminSDKサービスアカウントにはデフォルトでfirebaseauth.configs.getHashConfig権限がありません。ユーザー/サービスアカウントに直接アクセス許可を追加することはできませんが、カスタムIAMロールを作成することで間接的に追加できます。

カスタムIAMロールを作成するには:

  1. Google CloudConsoleのIAMと管理パネルの[役割]ページに移動します。
  2. ページ上部のドロップダウンからプロジェクトを選択します。
  3. [役割の作成]をクリックします
  4. [権限の追加]をクリックします
  5. firebaseauth.configs.getHashConfig権限を検索し、そのチェックボックスを選択します。
  6. [追加]をクリックします
  7. [作成]をクリックして、新しい役割の作成を終了します。

作成したカスタムロールをIAMページのユーザー/サービスアカウントに追加します。

  1. [IAMと管理]パネルで、[ IAM ]を選択します
  2. 編集するメンバーのリストからサービスまたはユーザーアカウントを選択します。
  3. [別の役割を追加]をクリックします。
  4. 以前に作成した新しいカスタムロールを検索します。
  5. [保存]をクリックします。