Lister ou rechercher des utilisateurs
Ce terminal récupère les détails des utilisateurs. Il convient surtout aux recherches et aux consultations interactives effectuées au mieux, lorsque des résultats légèrement désuets sont acceptables. Il permet de :
- spécifier des critères de recherche pour les utilisateurs
- trier les utilisateurs à retourner
- sélectionner les champs à retourner
- préciser le nombre d’utilisateurs à récupérer par page ainsi que l’index de la page
Ce terminal ne convient pas aux opérations critiques. Il offre une cohérence à terme et impose aux requêtes une courte limite de temps (environ 2 secondes). Les résultats peuvent donc être désuets, et les requêtes coûteuses peuvent retourner une erreur 503.
- N’utilisez pas ce terminal pour l’authentification, l’association de comptes ou la logique des Actions dans un flux de connexion. Utilisez plutôt la recherche directe d’utilisateurs par ID ou par courriel pour obtenir leurs données à jour.
- N’utilisez pas ce terminal pour synchroniser un système externe avec les données des utilisateurs. Abonnez-vous plutôt aux flux d’événements pour recevoir chaque modification dès qu’elle se produit.
- N’utilisez pas ce terminal pour répertorier ou exporter tous vos utilisateurs. Effectuez plutôt une exportation groupée des utilisateurs pour obtenir la liste complète.
Utilisez le paramètre de requête q pour trouver les utilisateurs correspondant à vos critères à l’aide de la syntaxe de chaîne de requête. Pour obtenir des instructions et des conseils détaillés, consultez Comment répertorier et rechercher des utilisateurs.
Pour des requêtes efficaces, privilégiez les champs indexés de premier niveau et les correspondances exactes. Certains types de requêtes peuvent être lents et dépasser le délai d’exécution, notamment le filtrage sur des champs à saisie libre ou à valeurs multiples (comme les attributs définis par l’utilisateur dans app_metadata ou user_metadata) et l’utilisation de caractères de remplacement au début des critères de recherche.
Autorisations
Paramètres de requête
Requête en syntaxe de chaîne de requête Lucene. Certains types de requêtes ne peuvent pas être utilisés sur les champs de métadonnées; pour en savoir plus, consultez Champs interrogeables.
Si true (par défaut), les résultats sont retournés dans un ordre déterministe. Si false, les résultats peuvent être retournés dans un ordre non déterministe, ce qui peut améliorer les performances pour les requêtes complexes ciblant un petit nombre d’utilisateurs. Définissez cette valeur sur false uniquement lorsqu’un ordre cohérent et la pagination ne sont pas requis.
Réponse
Utilisateurs récupérés avec succès.
- object[]
- object