Find roles with a query | Elasticsearch API (v8)

Find roles with a query Added in 8.15.0

GET /_security/_query/role

Get roles in a paginated manner. You can optionally filter the results with a query.

application/json

Body

query object

Additional properties are allowed.
Hide query attributes Show query attributes object
- bool
- exists
- ids
- match object
  
  Returns roles that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
- match_all
- prefix object
  
  Returns roles that contain a specific prefix in a provided field.
- range object
  
  Returns roles that contain terms within a provided range.
- simple_query_string
- term object
  
  Returns roles that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
- terms
- wildcard object
  
  Returns roles that contain terms matching a wildcard pattern.
from number

Starting document offset. 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.
sort string | object | array[string | object]
One of:
_types:Field string _types:SortOptions object _types:Sort array[string | object]

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Hide attributes Show attributes

_score object

Additional properties are allowed.

Hide _score attribute Show _score attribute object

order string

Values are asc or desc.

_doc object

Additional properties are allowed.

Hide _doc attribute Show _doc attribute object

order string

Values are asc or desc.

_geo_distance object

Additional properties are allowed.

Hide _geo_distance attributes Show _geo_distance attributes object

mode string

Values are min, max, sum, avg, or median.

distance_type string

Values are arc or plane.

ignore_unmapped boolean

order string

Values are asc or desc.

unit string

Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

nested object

Additional properties are allowed.

Hide nested attributes Show nested attributes object

filter object

Additional properties are allowed.

External documentation

max_children number

nested object

Additional properties are allowed.

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

_script object

Additional properties are allowed.

Hide _script attributes Show _script attributes object

order string

Values are asc or desc.

script object Required

Additional properties are allowed.

Hide script attributes Show script attributes object

source string

The script source.

id string

params object

Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

Hide params attribute Show params attribute object

* object Additional properties

Additional properties are allowed.

lang string

Any of:
_types:ScriptLanguage string _types:ScriptLanguage string

Values are painless, expression, mustache, or java.

options object

Hide options attribute Show options attribute object

* string Additional properties

type string

Values are string, number, or version.

mode string

Values are min, max, sum, avg, or median.

nested object

Additional properties are allowed.

Hide nested attributes Show nested attributes object

filter object

Additional properties are allowed.

External documentation

max_children number

nested object

Additional properties are allowed.

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
One of:
_types:Field string _types:SortOptions object

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

Hide attributes Show attributes

_score object

Additional properties are allowed.

Hide _score attribute Show _score attribute object

order string

Values are asc or desc.

_doc object

Additional properties are allowed.

Hide _doc attribute Show _doc attribute object

order string

Values are asc or desc.

_geo_distance object

Additional properties are allowed.

Hide _geo_distance attributes Show _geo_distance attributes object

mode string

Values are min, max, sum, avg, or median.

distance_type string

Values are arc or plane.

ignore_unmapped boolean

order string

Values are asc or desc.

unit string

Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

nested object

Additional properties are allowed.

Hide nested attributes Show nested attributes object

filter object

Additional properties are allowed.

max_children number

nested object

Additional properties are allowed.

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

_script object

Additional properties are allowed.

Hide _script attributes Show _script attributes object

order string

Values are asc or desc.

script object Required

Additional properties are allowed.

Hide script attributes Show script attributes object

source string

The script source.

id string

params object

Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

lang

options object

type string

Values are string, number, or version.

mode string

Values are min, max, sum, avg, or median.

nested object

Additional properties are allowed.

Hide nested attributes Show nested attributes object

filter object

Additional properties are allowed.

max_children number

nested object

Additional properties are allowed.

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
size number

The number of hits to return. 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.
search_after array[number | string | boolean | null | object]

A field value.

One of:
_types:FieldValue number _types:FieldValue number _types:FieldValue string _types:FieldValue boolean _types:FieldValue string | null _types:FieldValue object

Additional properties are allowed.

Responses

200 application/json
Hide response attributes Show response attributes object
- total number Required
  
  The total number of roles found.
- count number Required
  
  The number of roles returned in the response.
- roles array[object] Required
  
  The list of roles.
  
  Hide roles attributes Show roles attributes object
  
  cluster array[string]
  
  A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.
  
  indices array[object]
  
  A list of indices permissions entries.
  
  Hide indices attributes Show indices attributes object
  
  field_security object
  
  Additional properties are allowed.
  
  names string | array[string] Required
  
  privileges array[string] Required
  
  The index level privileges that owners of the role have on the specified indices.
  
  query
  
  allow_restricted_indices boolean
  
  Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices.
  
  global array[object] | object
  
  An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.
  
  One of:
  array-1 array[object] _types:GlobalPrivilege object
  
  Additional properties are allowed.
  
  applications array[object]
  
  A list of application privilege entries
  
  Hide applications attributes Show applications attributes object
  
  application string Required
  
  The name of the application to which this entry applies.
  
  privileges array[string] Required
  
  A list of strings, where each element is the name of an application privilege or action.
  
  resources array[string] Required
  
  A list resources to which the privileges are applied.
  
  metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  run_as array[string]
  
  A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.
  
  description string
  
  Optional description of the role descriptor
  
  transient_metadata object
  
  Hide transient_metadata attribute Show transient_metadata attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  _sort array[number | string | boolean | null | object]
  
  A field value.
  
  One of:
  _types:FieldValue number _types:FieldValue number _types:FieldValue string _types:FieldValue boolean _types:FieldValue string | null _types:FieldValue object
  
  Additional properties are allowed.
  
  name string Required
  
  Name of the role.

GET /_security/_query/role

curl \
 -X GET http://api.example.com/_security/_query/role \
 -H "Content-Type: application/json" \
 -d '{"query":{"match":{},"prefix":{},"range":{},"term":{},"wildcard":{}},"from":42.0,"":"string","size":42.0,"search_after":[42.0]}'

Request examples

{
  "query": {
    "match": {},
    "prefix": {},
    "range": {},
    "term": {},
    "wildcard": {}
  },
  "from": 42.0,
  "": "string",
  "size": 42.0,
  "search_after": [
    42.0
  ]
}

Response examples (200)

{
  "total": 42.0,
  "count": 42.0,
  "roles": [
    {
      "cluster": [
        "string"
      ],
      "indices": [
        {
          "field_security": {},
          "names": "string",
          "privileges": [
            "string"
          ],
          "allow_restricted_indices": true
        }
      ],
      "global": [
        {}
      ],
      "applications": [
        {
          "application": "string",
          "privileges": [
            "string"
          ],
          "resources": [
            "string"
          ]
        }
      ],
      "metadata": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      },
      "run_as": [
        "string"
      ],
      "description": "string",
      "transient_metadata": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      },
      "_sort": [
        42.0
      ],
      "name": "string"
    }
  ]
}

Find roles with a query Added in 8.15.0

Body

sort string | object | array[string | object]

lang string

Responses

global array[object] | object