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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Paramètres de requête
Index de la page de résultats à retourner. La première page est 0.
x >= 0Nombre de résultats par page.
0 <= x <= 100Retourne les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau direct de résultats (false, par défaut).
Champ de tri. Utilisez field:order, où l’ordre est 1 pour l’ordre croissant et -1 pour l’ordre décroissant. Par exemple : created_at:1
Filtre de connexion. S’applique uniquement lors de l’utilisation de search_engine=v1. Pour filtrer par connexion avec search_engine=v2|v3, utilisez q=identities.connection:"connection_name"
Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez ce paramètre vide pour récupérer tous les champs.
Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).
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.
La version du search engine
v1, v2, v3 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
ID de l’utilisateur pouvant être utilisé pour interagir avec d’autres API.
Adresse courriel de cet utilisateur.
Indique si cette adresse courriel est vérifiée (true) ou non (false).
Nom d’utilisateur de cet utilisateur.
Numéro de téléphone de cet utilisateur. Respecte la recommandation E.164.
Indique si ce numéro de téléphone a été vérifié (true) ou non (false).
Date et heure de création de cet utilisateur.
Date et heure de la dernière mise à jour/modification de cet utilisateur.
Tableau d’objets d’identité utilisateur lorsque des comptes sont liés.
Les métadonnées utilisateur auxquelles cet utilisateur a accès en lecture seule.
Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture et en écriture.
URL de l’image, de la photo ou de l’avatar de cet utilisateur.
Nom de cet utilisateur.
Surnom ou alias préféré de cet utilisateur.
Liste des fournisseurs d’authentification multifacteur auxquels cet utilisateur s’est inscrit.
Date et heure de la dernière mise à jour des fournisseurs d’authentification multifacteur de cet utilisateur.
Dernière adresse IP à partir de laquelle cet utilisateur s’est connecté.
Date et heure de la dernière connexion de cet utilisateur.
Date et heure de la dernière réinitialisation du mot de passe de cet utilisateur.
Nombre total de connexions effectuées par cet utilisateur.
Indique si cet utilisateur a été bloqué par un administrateur (true) ou non (false).
Prénom de cet utilisateur.
Nom de famille de cet utilisateur.