﻿---
title: stack es security query-role cli command
description: Find roles with a query. 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/query-role
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es security query-role cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es security query-role [options]
```

Find roles with a query.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--query string">
    A query to filter which roles to return.
    If the query parameter is missing, it is equivalent to a `match_all` query.
    The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,
    `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.
    You can query the following information associated with roles: `name`, `description`, `metadata`,
    `applications.application`, `applications.privileges`, and `applications.resources`.
  </definition>
  <definition term="--from number">
    The starting document offset.
    It must not be negative.
    By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
    To page through more hits, use the `search_after` parameter.
  </definition>
  <definition term="--sort string">
    The sort definition.
    You can sort on `name`, `description`, `metadata`, `applications.application`, `applications.privileges`,
    and `applications.resources`.
    In addition, sort can also be applied to the `_doc` field to sort by index order.
    **Repeatable:** pass `--sort` multiple times to supply more than one value
  </definition>
  <definition term="--size number">
    The number of hits to return.
    It must not be negative.
    By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
    To page through more hits, use the `search_after` parameter.
  </definition>
  <definition term="--search-after string[]">
    The search after definition.
    **Repeatable:** pass `--search-after` multiple times to supply more than one value
  </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>