stack es security query-user cli command
Auth required
Idempotent
Scope: global
elastic stack es security query-user [options]
Find users with a query.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--[no-]with-profile-uid- Determines whether to retrieve the user profile UID, if it exists, for the users.
--querystring- A query to filter which users to return.
If the query parameter is missing, it is equivalent to a
match_allquery. The query supports a subset of query types, includingmatch_all,bool,term,terms,match,ids,prefix,wildcard,exists,range, andsimple_query_string. You can query the following information associated with user:username,roles,enabled,full_name, andemail. --fromnumber- The starting document offset.
It must not be negative.
By default, you cannot page through more than 10,000 hits using the
fromandsizeparameters. To page through more hits, use thesearch_afterparameter. --sortstring-
The sort definition. Fields eligible for sorting are:
username,roles,enabled. In addition, sort can also be applied to the_docfield to sort by index order.Repeatable: pass
--sortmultiple times to supply more than one value --sizenumber- The number of hits to return.
It must not be negative.
By default, you cannot page through more than 10,000 hits using the
fromandsizeparameters. To page through more hits, use thesearch_afterparameter. --search-afterstring[]- The search after definition
--[no-]error-trace- When set to
trueElasticsearch will include the full stack trace of errors when they occur. --filter-pathstring-
Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
Repeatable: pass
--filter-pathmultiple times to supply more than one value --[no-]human- When set to
truewill return statistics in a format suitable for humans. For example"exists_time": "1h"for humans and"exists_time_in_millis": 3600000for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. --[no-]pretty- If set to
truethe returned JSON will be "pretty-formatted". Only use this option for debugging only. --input-filestring- path to a JSON file to use as command input
--[no-]dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--[no-]json-
output as JSON