Passer au contenu principal
Le point de terminaison GET /api/v2/users vous permet de récupérer une liste d’utilisateurs. Ce point de terminaison permet ce qui suit :
  • Rechercher sur la base d’un grand nombre de critères
  • Sélectionner les champs à envoyer
  • Trier les résultats obtenus
Ce point de terminaison est persistant et, à ce titre, nous vous recommandons de l’utiliser pour les processus administratif tels que la modification du nom d’affichage d’un utilisateur existant.

​
Exemple de demande

Pour rechercher des utilisateurs, faites une requête GET au point de terminaison /api/v2/users. La requête doit inclure un jeton d’accès de Management API. Passez votre requête de recherche dans le paramètre q et attribuez la valeur search_engine au paramètre v3. Par exemple, pour rechercher un utilisateur dont le courriel est exactement jane@exampleco.com, utilisez q=email:"jane@exampleco.com » : Si la recherche aboutit, vous recevrez une réponse semblable à celle-ci :

​
Exemples de requêtes

Vous trouverez ci-dessous quelques exemples des types de requêtes que vous pouvez effectuer à l’aide de Management API.

​
Limites

Le point de terminaison renvoie un maximum de 50 utilisateurs, même si davantage d’utilisateurs correspondent à votre requête. Si vous voulez obtenir plus de 50 utilisateurs, utilisez le paramètre page pour afficher un plus grand nombre de pages de résultats. Chaque page contient 50 utilisateurs. Par exemple, vous pouvez préciser &page=2 pour afficher les résultats 51-100, préciser &page=3 pour afficher les résultats 101-150, et ainsi de suite. Cependant, ce point de terminaison ne renvoie jamais un total de plus de 1 000 utilisateurs ayant les mêmes critères de recherche, même avec le paramètre page. Les données utilisateur qui peuvent être indexées, interrogées et renvoyées par le point de terminaison de recherche utilisateur sont limitées à 1 Mo par utilisateur. Pour plus d’informations sur la manière dont cela affecte les métadonnées personnalisées de plus de 1 Mo, consultez Noms des champs de métadonnées et types de données. Le point de terminaison obtenir utilisateur doit être utilisé pour récupérer tous les attributs de l’utilisateur pour les profils utilisateurs surdimensionnés. Si vous avez besoin d’une exportation complète de tous vos utilisateurs, utilisez la tâche d’exportation ou l’extension Importation/Exportation des utilisateurs.. Si vous obtenez l’erreur 414 Request-URI Too Large, cela signifie que votre chaîne de requête est plus longue que la longueur prise en charge. Dans ce cas, affinez votre recherche. Nous ne recommandons pas l’utilisation de ce point de terminaison pour :
  • Les opérations qui nécessitent une cohérence immédiate. Utilisez plutôt le point de terminaison Obtenir des utilisateurs par courriel ou Obtenir des utilisateurs par identifiant.
  • Les exportations d’utilisateurs. Utilisez plutôt le point de terminaison Exportation utilisateur.
  • Les opérations qui nécessitent une recherche de l’utilisateur dans le cadre des processus d’authentification. Utilisez plutôt le point de terminaison Obtenir des utilisateurs par courriel ou Obtenir des utilisateurs par identifiant.
  • La recherche d’utilisateurs pour l’association de comptes par courriel. Utilisez plutôt le point de terminaison Obtenir des utilisateurs par courriel.

​
En savoir plus