[[reference-security-suggest_user_profiles]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
[[client.security.suggestUserProfiles]]
=== client.security.suggestUserProfiles

Suggest a user profile. Get suggestions for user profiles that match specified search criteria.

{ref}/security-api-suggest-user-profile.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(SecuritySuggestUserProfilesRequest, options?): Promise<SecuritySuggestUserProfilesResponse>
----

[discrete]
==== Request

[pass]
++++
<pre>
++++
interface SecuritySuggestUserProfilesRequest extends <<RequestBase>> {
  name?: string
  size?: <<long>>
  data?: string | string[]
  hint?: SecuritySuggestUserProfilesHint
}

[pass]
++++
</pre>
++++
[discrete]
==== Response

[pass]
++++
<pre>
++++
interface SecuritySuggestUserProfilesResponse {
  total: SecuritySuggestUserProfilesTotalUserProfiles
  took: <<long>>
  profiles: <<SecurityUserProfile>>[]
}

[pass]
++++
</pre>
++++