Comment répertorier et rechercher des utilisateurs à l’aide de requêtes de recherche

Récupérez la liste de tous les profils utilisateur et filtrez les résultats à l’aide de chaînes de requête de recherche Lucene.

À l’aide du Auth0 Dashboard ou de la Management API, vous pouvez récupérer une liste d’utilisateurs et filtrer les résultats selon les critères de recherche de votre choix.

​

Lister et rechercher des utilisateurs

Auth0 Dashboard

Pour afficher la liste des utilisateurs, accédez à Dashboard > User Management > Users.

Le champ de recherche et le menu déroulant situés en haut de la page vous permettent d’effectuer une recherche selon les propriétés suivantes :

• Utilisateur
• Courriel
• Fournisseur d’identité
• Connexion
• ID d’organisation
• Nombre de connexions
• Dernière connexion
• Numéro de téléphone

Vous pouvez également sélectionner Lucene Syntax (Advanced) pour définir des critères de recherche. La référence de la syntaxe des requêtes de recherche contient davantage d’information sur les fonctionnalités de recherche prises en charge et des exemples de requêtes.

Management API

L’endpoint permettant de répertorier ou de rechercher des utilisateurs (GET /users) de la Management API est à cohérence éventuelle. Les résultats peuvent donc ne pas refléter immédiatement les opérations d’écriture récemment effectuées. Nous recommandons d’utiliser cet endpoint pour les opérations qui ne sont pas urgentes, comme modifier le nom d’affichage d’un utilisateur existant.

Quand utiliser le point de terminaison List or Search Users

• N’utilisez pas ce point de terminaison dans le cadre d’un processus d’authentification, pour la liaison de comptes ou lorsqu’une cohérence immédiate est requise. Utilisez plutôt les points de terminaison de la Management API pour obtenir des utilisateurs par ID ou par courriel.

• N’utilisez pas le point de terminaison List or Search Users pour exporter des utilisateurs. Utilisez plutôt les exportations d’utilisateurs en bloc.

Pour obtenir la liste de tous les utilisateurs avec la Management API, effectuez une requête à l’endpoint List or Search Users (GET /users). Pour rechercher des utilisateurs, précisez les critères de recherche à l’aide du query parameter q et d’une query string de recherche Lucene.

Par exemple, pour rechercher un utilisateur dont le nom est exactement example :

Les requêtes de recherche expirent (code d’état HTTP 503) si elles ne s’exécutent pas en deux secondes ou moins. Si votre requête de recherche expire, c’est peut-être qu’elle est trop coûteuse ou qu’elle comporte une erreur qui l’empêche de s’exécuter à temps.

L’erreur 414 Request-URI Too Large signifie que votre query string dépasse la longueur prise en charge. Dans ce cas, affinez votre recherche.

La référence de la syntaxe des requêtes de recherche fournit plus de renseignements sur les fonctionnalités de recherche prises en charge, ainsi que des exemples de requêtes.

​

Trier les résultats

Auth0 Dashboard

Dans l’Auth0 Dashboard, vous pouvez trier les résultats en sélectionnant les colonnes disponibles dans la table des utilisateurs :

• Nom
• ID utilisateur
• Connection
• Connexions
• Dernière connexion

Sélectionnez une fois le titre d’une colonne pour trier par ordre croissant, puis une deuxième fois pour trier par ordre décroissant. Pour trier les résultats selon d’autres champs, utilisez la Management API.

Management API

Pour trier les résultats de la recherche d’utilisateurs, attribuez au paramètre de requête sort la valeur field:order, où :

• field est le nom du champ selon lequel effectuer le tri
• order vaut 1 pour l’ordre croissant ou -1 pour l’ordre décroissant.

Par exemple, pour trier les utilisateurs en ordre croissant selon leur date de création, attribuez au paramètre sort la valeur created_at:1 :

​

Recommandations sur les performances

Suivez les recommandations suivantes pour optimiser les performances de la recherche d’utilisateurs :

• Le endpoint List or Search Users de la Management API renvoie les résultats dans un ordre déterministe, de sorte qu’une même requête produit toujours les mêmes résultats dans le même ordre logique. La recherche non déterministe est plus rapide. Si une recherche déterministe n’est pas nécessaire pour votre cas d’utilisation, optez pour une recherche non déterministe en définissant primary_order=false.

• Échappez les espaces (par exemple, écrivez q=name:John Doe sous la forme q=name:John\ Doe).

• Limitez l’utilisation des caractères génériques, surtout avec de grands ensembles de données. Lorsque vous les utilisez, privilégiez les suffixes plutôt que les préfixes du terme de recherche.

• Évitez les critères de recherche qui renvoient plus de 1 000 résultats.

• Évitez les requêtes d’existence (par exemple, « donnez-moi tous les utilisateurs ayant une propriété, quelle que soit sa valeur »).

• Pour les attributs définis par l’utilisateur dans app_metadata et user_metadata :

  • Limitez les champs de métadonnées à 2 Ko ou moins.

  • Utilisez des types de données cohérents et des noms fixes pour les propriétés de métadonnées.

  • Évitez les schémas volumineux et les structures imbriquées en profondeur.

• Évitez d’effectuer des recherches d’utilisateurs dans les points d’extension du flux de connexion, comme les Actions post-login.

• N’interrogez pas les API de recherche de façon répétée.

​

Limites

• La recherche renvoie au maximum 1 000 utilisateurs, même si votre requête correspond à un plus grand nombre d’utilisateurs. Lorsque vous utilisez l’API, les résultats volumineux sont paginés.

• L’endpoint List or Search Users de la Management API impose une limite de 1 Mo de données utilisateur par utilisateur pouvant être indexées, interrogées et renvoyées. Pour récupérer tous les attributs d’un profil utilisateur volumineux, récupérez les utilisateurs par ID ou par courriel.

• L’endpoint List or Search Users de la Management API ne prend pas en charge le tri selon app_metadata ou user_metadata.