Terms
Terms define strings to search for. Terms support fields, wildcards, and ranges.Fields
Fields define where to search for the given string. The full list of user profile attributes indicates which fields are searchable.-
All search values are case sensitive except for search values for normalized user profile fields (
email,name,given_name,family_name, andnickname), which are case insensitive. -
You can search
app_metadataanduser_metadatafields with a data type of boolean, integer, double, text, object, or array. -
You cannot search metadata fields that contain an empty array, empty object, or
nullvalue because those values are not indexed. -
Terms without field names do not match
user_metadata.
When searching metadata, you can search nested values using the path to the field. If the field is nested in an array, you can ignore the array level. For example, with the following
user_metadata structure:
Wildcards
Wildcards match multiple characters using the syntax*.
-
For suffix matching, literals must have 3 characters or more. For example,
name:*abcis allowed, butname:*abis not. -
You cannot search
user_metadatawith wildcards.
Ranges
Ranges match values between the specified upper and lower bound.- You cannot search
user_metadatawith ranges.