﻿---
title: stack es security suggest-user-profiles cli command
description: Suggest a user profile. Behaviour flags: --dry-run — validate all inputs and exit without performing any action 
url: https://www.elastic.co/elastic/docs-builder/docs/4097/reference/elastic-cli/cli/stack/es/security/suggest-user-profiles
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es security suggest-user-profiles cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es security suggest-user-profiles [options]
```

Suggest a user profile.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--data 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.
    **Repeatable:** pass `--data` multiple times to supply more than one value
  </definition>
  <definition term="--name string">
    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`.
  </definition>
  <definition term="--size number">
    The number of profiles to return.
  </definition>
  <definition term="--hint string">
    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.
  </definition>
  <definition term="--error-trace">
    When set to `true` Elasticsearch will include the full stack trace of errors
    when they occur.
  </definition>
  <definition term="--filter-path string">
    Comma-separated list of filters in dot notation which reduce the response
    returned by Elasticsearch.
    **Repeatable:** pass `--filter-path` multiple times to supply more than one value
  </definition>
  <definition term="--human">
    When set to `true` will return statistics in a format suitable for humans.
    For example `"exists_time": "1h"` for humans and
    `"exists_time_in_millis": 3600000` for computers. When disabled the human
    readable values will be omitted. This makes sense for responses being consumed
    only by machines.
  </definition>
  <definition term="--pretty">
    If set to `true` the returned JSON will be "pretty-formatted". Only use
    this option for debugging only.
  </definition>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
  <definition term="--dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>