Find users with a query | Elasticsearch API documentation (v8)

Find users with a query Added in 8.14.0

POST /_security/_query/user

Api key auth Basic auth Bearer auth

Get information for users in a paginated manner. You can optionally filter the results with a query.

NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users.

Query parameters

with_profile_uid boolean

Determines whether to retrieve the user profile UID, if it exists, for the users.

application/json

Body

query object
Hide query attributes Show query attributes object
- ids
- bool
- exists
- match object
  
  Returns users that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
- match_all
- prefix object
  
  Returns users that contain a specific prefix in a provided field.
- range object
  
  Returns users that contain terms within a provided range.
- simple_query_string
- term object
  
  Returns users 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 users that contain terms matching a wildcard pattern.
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.
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

Hide _score attribute Show _score attribute object

order string

Values are asc or desc.

_doc object

Hide _doc attribute Show _doc attribute object

order string

Values are asc or desc.

_geo_distance object

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

Hide nested attributes Show nested attributes object

filter object

An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

External documentation

max_children number

nested object

path string Required

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

_script object

Hide _script attributes Show _script attributes object

order string

Values are asc or desc.

script object Required

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

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

Hide nested attributes Show nested attributes object

filter object

An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

External documentation

max_children number

nested object

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

Hide _score attribute Show _score attribute object

order string

Values are asc or desc.

_doc object

Hide _doc attribute Show _doc attribute object

order string

Values are asc or desc.

_geo_distance object

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

Hide nested attributes Show nested attributes object

filter object

An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

max_children number

nested object

path string Required

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

_script object

Hide _script attributes Show _script attributes object

order string

Values are asc or desc.

script object Required

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

Hide nested attributes Show nested attributes object

filter object

An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

max_children number

nested object

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. 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.
search_after array[number | string | boolean | null | object]

A field value.

A field value.

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

Responses

200 application/json
Hide response attributes Show response attributes object
- total number Required
  
  The total number of users found.
- count number Required
  
  The number of users returned in the response.
- users array[object] Required
  
  A list of users that match the query.
  
  Hide users attributes Show users attributes object
  
  email string
  
  full_name string
  
  metadata object Required
  
  Hide metadata attribute Show metadata attribute object
  
  * object Additional properties
  
  roles array[string] Required
  
  username string Required
  
  enabled boolean Required
  
  profile_uid string
  
  _sort array[number | string | boolean | null | object]
  
  A field value.
  
  A field value.
  
  One of:
  _types:FieldValue number _types:FieldValue number _types:FieldValue string _types:FieldValue boolean _types:FieldValue string | null _types:FieldValue object

POST /_security/_query/user

curl \
 --request POST http://api.example.com/_security/_query/user \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"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,
  "users": [
    {
      "email": "string",
      "full_name": "string",
      "metadata": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      },
      "roles": [
        "string"
      ],
      "username": "string",
      "enabled": true,
      "profile_uid": "string",
      "_sort": [
        42.0
      ]
    }
  ]
}

Find users with a query Added in 8.14.0

Query parameters

Body

sort string | object | array[string | object]

lang string

Responses