AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 8.2This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Get suggestions for user profiles that match specified search criteria.
Note
The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.
Individual users and external applications should not call this API directly.
Elastic reserves the right to change or remove this feature in future releases without prior notice.
A comma-separated list of filters for the data field of the profile document.
To return all content use data=*.
To return a subset of content, use data=<key> to retrieve content nested under the specified <key>.
By default, the API returns no data content.
It is an error to specify data as both the query parameter and the request body field.
A query string used to match name-related fields in user profile documents.
Name-related fields are the user's username, full_name, and email.
sizenumber · default: 10
The number of profiles to return.
dataunionstring | string[]
A comma-separated list of filters for the data field of the profile document.
To return all content use data=*.
To return a subset of content, use data=<key> to retrieve content nested under the specified <key>.
By default, the API returns no data content.
It is an error to specify data as both the query parameter and the request body field.
hintobject
Extra search criteria to improve relevance of the suggestion result.
Profiles matching the spcified hint are ranked higher in the response.
Profiles not matching the hint aren't excluded from the response as long as the profile matches the name field query.
uidsstring[]
A list of profile UIDs to match against.
labelsmapstring to string | string[]
A single key-value pair to match against the labels section
of a profile. A profile is considered matching if it matches
at least one of the strings.