Syntaxe et exemples de requêtes Lucene pour User Search d’Auth0

Consultez les détails et des exemples de syntaxe de requête Lucene pour User Search d’Auth0 version 3.

Lorsque vous listez les utilisateurs, vous pouvez filtrer les résultats à l’aide de requêtes de recherche utilisant la syntaxe de requête Lucene.

La référence de la syntaxe de requête Lucene fait autorité, mais de façon générale, la chaîne de requête est analysée en une série de termes et d’opérateurs booléens.

​

Termes

Les termes définissent les chaînes à rechercher. Les termes prennent en charge les champs, les caractères génériques et les plages.

​

Champs

Les champs définissent où rechercher la chaîne indiquée. La liste complète des attributs du profil utilisateur indique quels champs sont interrogeables.

• Toutes les valeurs de recherche sont sensibles à la casse, à l’exception de celles des champs du profil utilisateur normalisé (email, name, given_name, family_name et nickname), qui ne le sont pas.

• Vous pouvez effectuer des recherches dans les champs app_metadata et user_metadata dont le type de données est booléen, entier, double, texte, objet ou tableau.

• Vous ne pouvez pas rechercher les champs de métadonnées qui contiennent un tableau vide, un objet vide ou une valeur null, car ces valeurs ne sont pas indexées.

• Les termes sans nom de champ ne correspondent pas à user_metadata.

Critères de recherche	Exemple de requête
Utilisateurs dont le nom est exactement “eugenio”	name:"eugenio"
Utilisateurs dont le domaine de courriel est example.com	email.domain:"example.com"
Utilisateurs provenant d’une connexion précise	identities.connection:"google-oauth2"

Lorsque vous recherchez des métadonnées, vous pouvez rechercher des valeurs imbriquées à l’aide du chemin d’accès au champ. Si le champ est imbriqué dans un tableau, vous pouvez ignorer le niveau du tableau. Par exemple, avec la structure user_metadata suivante :

{
  "full_name": "Example Name",
  "display": {
    "preferredLanguage": "en",
    "fontSize": 13
  },
  "addresses":{
    "cities": [ "Paris", "Seattle" ]
  }
}

Critères de recherche	Exemple de requête
Utilisateurs dont le nom complet est “Example Name”	user_metadata.full_name:"Example Name"
Utilisateurs ayant défini une langue préférée	q: _exists_:user_metadata.display.preferredLanguage
Utilisateurs dont la taille de police est réglée à 13	q: user_metadata.display.fontSize:13
Utilisateurs dont les villes comprennent Paris	q: user_metadata.addresses.cities:"Paris"

​

Caractères génériques

Les caractères génériques permettent de faire correspondre plusieurs caractères à l’aide de la syntaxe *.

• Pour faire correspondre un suffixe, les chaînes littérales doivent comporter au moins 3 caractères. Par exemple, name:*abc est autorisé, mais name:*ab ne l’est pas.

• Vous ne pouvez pas effectuer de recherche avec des caractères génériques dans user_metadata.

Critères de recherche	Exemple de requête
Utilisateurs dont le nom contient « example »	name:*example*
Utilisateurs dont l’adresse courriel commence par « test »	email:test*

​

Plages

Les plages correspondent aux valeurs comprises entre les bornes inférieure et supérieure spécifiées.

• Vous ne pouvez pas effectuer de recherche par plage dans user_metadata.

Critères de recherche	Exemple de requête
Utilisateurs ayant effectué 9 connexions ou moins	logins_count:[* TO 10}
Utilisateurs ayant effectué de 10 à 99 connexions	logins_count:[10 TO 100}
Utilisateurs ayant effectué 100 connexions ou plus	logins_count:[100 TO *]
Utilisateurs dont la dernière connexion date d’avant 2025	last_login:[* TO 2024-12-31]
Utilisateurs dont la dernière connexion a eu lieu en décembre 2025	last_login:[2025-12-01 TO 2025-12-31]

​

Opérateurs booléens

Les opérateurs booléens permettent de combiner logiquement des termes. Ils s’appliquent à tous les champs du profil utilisateur normalisé et aux champs de métadonnées racine.

Critères de recherche	Exemple de requête
Utilisateurs dont le nom correspond exactement à « example name » ou à « test user »	name:("example name" OR "test user")
Utilisateurs sans adresse courriel vérifiée	NOT _exists_:email_verified OR email_verified:false
Utilisateurs qui ne se sont jamais connectés	NOT _exists_:logins_count OR logins_count:0