Gérer les utilisateurs

Le SDK Admin Firebase fournit une API pour gérer vos utilisateurs Firebase Authentication avec des privilèges élevés. L'API de gestion des utilisateurs administrateur vous permet d'effectuer les tâches suivantes par programmation à partir d'un environnement de serveur sécurisé:

• Créez des utilisateurs sans limitation de débit ni de débit.
• Recherchez des utilisateurs en fonction de différents critères, comme leur uid, leur adresse e-mail ou leur numéro de téléphone.
• Répertoriez tous les utilisateurs d'un projet spécifié par lot.
• Accéder aux métadonnées utilisateur, y compris la date de création du compte et la date de la dernière connexion
• Supprimez des utilisateurs sans demander leur mot de passe existant.
• Mettez à jour les propriétés utilisateur, y compris leur mot de passe, sans avoir à vous connecter en tant qu'utilisateur.
• Validez les e-mails sans avoir à passer par les flux d'actions hors bande pour les valider.
• Modifier l'adresse e-mail d'un utilisateur sans envoyer de liens par e-mail pour révoquer ces modifications
• Créez un utilisateur avec un numéro de téléphone sans avoir à passer par la procédure de validation par SMS.
• Modifier le numéro de téléphone d'un utilisateur sans avoir à passer par la procédure de validation par SMS
• Provisionnez les utilisateurs hors connexion dans un état désactivé, puis contrôlez plus tard quand les activer.
• Créez des consoles utilisateur personnalisées adaptées au système de gestion des utilisateurs d'une application spécifique.

Avant de commencer

Pour utiliser l'API de gestion des utilisateurs fournie par le SDK Admin Firebase, vous devez disposer d'un compte de service. Pour savoir comment initialiser le SDK Admin, suivez les instructions de configuration.

Récupérer des données utilisateur

Le moyen principal d'identifier un utilisateur est d'utiliser son uid, un identifiant unique de cet utilisateur. Le SDK Admin fournit une méthode permettant de récupérer les informations de profil des utilisateurs par 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}");

Cette méthode renvoie un objet UserRecord pour l'utilisateur correspondant au uid fourni à la méthode.

Si le uid fourni n'appartient pas à un utilisateur existant ou si l'utilisateur ne peut pas être extrait pour une autre raison, la méthode ci-dessus génère une erreur. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la section Erreurs de l'API Auth Admin.

Dans certains cas, vous disposez de l'adresse e-mail de l'utilisateur au lieu de son uid. Le SDK Admin Firebase permet de rechercher des informations utilisateur à l'aide d'une adresse e-mail:

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

Cette méthode renvoie un objet UserRecord pour l'utilisateur correspondant à l'adresse e-mail fournie.

Si l'adresse e-mail fournie n'appartient pas à un utilisateur existant ou si l'utilisateur ne peut pas être extrait pour toute autre raison, le SDK Admin génère une erreur. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Admin Authentication.

Avertissement :Pour la recherche d'e-mails, vous ne pouvez rechercher que l'adresse e-mail principale (de premier niveau), et non les adresses e-mail spécifiques au fournisseur. Par exemple, si un compte Facebook avec une autre adresse e-mail [e-mail] est associé à un utilisateur existant avec l'adresse e-mail [e-mail], l'appel à getUserByEmail("[e-mail]") ne donne aucun résultat, tandis que getUserByEmail("[e-mail]") renvoie l'utilisateur attendu. Si vous utilisez le paramètre par défaut "Un seul compte par adresse e-mail", la première adresse e-mail utilisée pour vous connecter sera utilisée comme adresse e-mail de premier niveau, sauf si vous la modifiez par la suite. Lorsque l'option "Plusieurs comptes par adresse e-mail" est définie, l'adresse e-mail principale n'est définie que lorsqu'un utilisateur de mot de passe est créé, sauf si elle est mise à jour manuellement.

Dans d'autres cas, vous disposez du numéro de téléphone de l'utilisateur au lieu de son uid. Le SDK Firebase Admin permet de rechercher des informations utilisateur à l'aide d'un numéro de téléphone:

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

Cette méthode renvoie un objet UserRecord pour l'utilisateur correspondant au numéro de téléphone fourni.

Si le numéro de téléphone fourni n'appartient pas à un utilisateur existant ou si l'utilisateur ne peut pas être extrait pour une autre raison, le SDK Admin génère une erreur. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Admin Authentication.

Récupérer des informations sur l'utilisateur de manière groupée

Le SDK Firebase Admin permet également de récupérer une liste d'utilisateurs basée sur les identifiants que vous fournissez. Vous pouvez identifier les utilisateurs par leur ID utilisateur, leur adresse e-mail ou leur numéro de téléphone. Vous pouvez fournir jusqu'à 100 identifiants par appel. Les identifiants peuvent contenir une combinaison de types:

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

Java

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

Python

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)

Go

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

C#

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

Cette méthode renvoie une liste de même taille que la liste d'entrée, chaque entrée contenant le champ UserRecord correspondant ou une erreur indiquant pourquoi cet identifiant n'a pas pu être recherché. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Admin Authentication.

Créer un compte utilisateur

Le SDK Admin fournit une méthode qui vous permet de créer un utilisateur Firebase Authentication. Cette méthode accepte un objet contenant les informations de profil à inclure dans le compte utilisateur nouvellement créé:

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

Java

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

Python

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

Go

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

C#

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

Par défaut, Firebase Authentication génère un uid aléatoire pour le nouvel utilisateur. Si vous souhaitez spécifier votre propre uid pour le nouvel utilisateur, vous pouvez l'inclure en tant qu'argument transmis à la méthode de création d'utilisateur:

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

Java

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

Python

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

Go

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

C#

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

Vous pouvez fournir n'importe quelle combinaison des propriétés suivantes:

Tableau 1. Propriétés compatibles avec l'opération de création d'utilisateur

Propriété	Type	Description
uid	chaîne	Le uid à attribuer au nouvel utilisateur créé. Doit être une chaîne de 1 à 128 caractères inclus. S'il n'est pas fourni, un uid aléatoire est généré automatiquement. Les uid plus courts offrent de meilleures performances.
email	chaîne	Adresse e-mail principale de l'utilisateur. Il doit s'agir d'une adresse e-mail valide.
emailVerified	boolean	Indique si l'adresse e-mail principale de l'utilisateur est validée ou non. Si aucune valeur n'est spécifiée, la valeur par défaut est false.
phoneNumber	chaîne	Numéro de téléphone principal de l'utilisateur. Il doit s'agir d'un numéro de téléphone valide conforme à la norme E.164.
password	chaîne	Mot de passe brut non haché de l'utilisateur. Ce champ doit comporter au moins six caractères.
displayName	chaîne	Nom à afficher des utilisateurs.
photoURL	chaîne	URL de la photo de l'utilisateur.
disabled	boolean	Indique si l'utilisateur est désactivé ou non. true pour désactivé ; false pour activé. Si cette valeur n'est pas spécifiée, la valeur par défaut est false.

Remarque :Toutes les propriétés ci-dessus sont facultatives. Si une propriété n'est pas spécifiée, sa valeur sera vide, sauf si une valeur par défaut est mentionnée dans le tableau ci-dessus.

La méthode de création d'utilisateurs renvoie un objet UserRecord pour l'utilisateur nouvellement créé.

Si l'uid, l'adresse e-mail ou le numéro de téléphone fournis sont déjà utilisés par un utilisateur existant ou si l'utilisateur ne peut pas être créé pour une autre raison, la méthode ci-dessus échoue et renvoie une erreur. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Authentication pour les administrateurs.

Modifier un utilisateur

Le SDK Admin Firebase facilite la modification des données d'un utilisateur existant. Vous devez spécifier un uid, ainsi que les propriétés à mettre à jour pour cet utilisateur:

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

Java

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

Python

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

Go

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

C#

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

Vous pouvez fournir n'importe quelle combinaison des propriétés suivantes:

Tableau 2. Propriétés compatibles avec l'opération de mise à jour de l'utilisateur

Propriété	Type	Description
email	chaîne	Nouvelle adresse e-mail principale de l'utilisateur. Il doit s'agir d'une adresse e-mail valide.
emailVerified	boolean	Indique si l'adresse e-mail principale de l'utilisateur est validée ou non. Si aucune valeur n'est spécifiée, la valeur par défaut est false.
phoneNumber	chaîne	Nouveau numéro de téléphone principal de l'utilisateur. Il doit s'agir d'un numéro de téléphone valide conforme à la norme E.164. Définissez cette valeur sur null pour effacer le numéro de téléphone existant de l'utilisateur.
password	chaîne	Le nouveau mot de passe brut non haché de l'utilisateur. Ce champ doit comporter au moins six caractères.
displayName	chaîne | null	Nouveau nom à afficher de l'utilisateur. Définissez cette valeur sur null pour effacer le nom à afficher existant de l'utilisateur.
photoURL	chaîne | null	URL de la nouvelle photo de l'utilisateur. Définissez cette valeur sur null pour effacer l'URL de la photo existante de l'utilisateur. S'il ne s'agit pas de null, il doit s'agir d'une URL valide.
disabled	boolean	Indique si l'utilisateur est désactivé ou non. true pour désactivé ; false pour activé.

Remarque :Toutes les propriétés ci-dessus sont facultatives. Si une propriété n'est pas spécifiée, sa valeur existante reste inchangée.

La méthode update user renvoie un objet UserRecord mis à jour une fois la mise à jour terminée.

Si l'uid fourni ne correspond pas à un utilisateur existant, que l'adresse e-mail ou le numéro de téléphone fournis sont déjà utilisés par un utilisateur existant ou que l'utilisateur ne peut pas être mis à jour pour une autre raison, la méthode ci-dessus échoue et génère une erreur. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la section Erreurs de l'API Admin Authentication.

Supprimer un compte utilisateur

Le SDK Firebase Admin permet de supprimer des utilisateurs existants en fonction de leur 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.");

La méthode de suppression d'utilisateur renvoie un résultat vide une fois la suppression terminée.

Si le uid fourni ne correspond pas à un utilisateur existant ou si l'utilisateur ne peut pas être supprimé pour une autre raison, la méthode de suppression de l'utilisateur génère une erreur. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Admin Authentication.

Supprimer plusieurs comptes utilisateur

Le SDK Firebase Admin peut également supprimer plusieurs utilisateurs à la fois. Toutefois, notez que l'utilisation de méthodes telles que deleteUsers(uids) pour supprimer plusieurs utilisateurs à la fois ne déclenchera pas les gestionnaires d'événements onDelete() pour Cloud Functions for Firebase. En effet, la suppression par lot ne déclenche pas d'événement de suppression d'utilisateur pour chaque utilisateur. Supprimez les utilisateurs un par un si vous souhaitez que des événements de suppression d'utilisateurs se déclenchent pour chaque utilisateur supprimé.

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

La méthode de suppression d'utilisateurs renvoie une liste d'échecs pour les utilisateurs qui n'ont pas pu être supprimés. Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Admin Authentication.

Répertorier tous les utilisateurs

Le SDK Firebase Admin permet de récupérer la liste complète des utilisateurs par lot:

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

Chaque lot de résultats contient une liste d'utilisateurs et le jeton de page suivant utilisé pour lister le prochain lot d'utilisateurs. Lorsque tous les utilisateurs ont déjà été répertoriés, aucun résultat pageToken n'est renvoyé.

Si aucun champ maxResults n'est spécifié, la valeur par défaut est de 1 000 utilisateurs par lot. Il s'agit également du nombre maximal d'utilisateurs autorisés à la fois. Toute valeur supérieure à la valeur maximale génère une erreur d'argument. Si aucun élément pageToken n'est spécifié, l'opération répertorie les utilisateurs depuis le début, triés par uid.

Pour obtenir la liste complète des codes d'erreur, y compris les descriptions et les étapes de résolution, consultez la page Erreurs de l'API Admin Authentication.

Hachages de mot de passe des utilisateurs listés

Cette API renvoie également les passwordSalt et passwordHash hachés par le backend Firebase Auth pour les utilisateurs de mot de passe si le compte utilisateur/de service utilisé pour générer le jeton d'accès OAuth de la requête dispose de l'autorisation firebaseauth.configs.getHashConfig. Sinon, passwordHash et passwordSalt ne seront pas définis.

En raison de la nature sensible des hachages de mots de passe, le compte de service du SDK Admin Firebase ne dispose pas de l'autorisation firebaseauth.configs.getHashConfig par défaut. Vous ne pouvez pas ajouter d'autorisation directement à un compte utilisateur/de service, mais vous pouvez le faire indirectement en créant un rôle IAM personnalisé.

Pour créer le rôle IAM personnalisé:

1. Accédez à la page Rôles dans le panneau IAM et administration de la console Google Cloud.
2. Sélectionnez votre projet dans le menu déroulant en haut de la page.
3. Cliquez sur CRÉER UN RÔLE.
4. Cliquez sur AJOUTER DES AUTORISATIONS.
5. Recherchez l'autorisation firebaseauth.configs.getHashConfig, puis cochez la case correspondante.
6. Cliquez sur AJOUTER.
7. Cliquez sur CRÉER pour finaliser la création du rôle.

Ajoutez le rôle personnalisé créé au compte utilisateur/de service sur la page IAM:

1. Dans le panneau IAM et administration, sélectionnez IAM.
2. Sélectionnez le compte de service ou d'utilisateur à modifier dans la liste des membres.
3. Cliquez sur AJOUTER UN AUTRE RÔLE.
4. Recherchez le nouveau rôle personnalisé que vous avez créé précédemment.
5. Cliquez sur ENREGISTRER.

Avertissement :N'utilisez pas le rôle Editor pour ajouter l'autorisation firebaseauth.configs.getHashConfig. Ce rôle puissant accorde des autorisations au-delà du champ d'application prévu.