stack es security suggest-user-profiles cli command
Auth required
Idempotent
Scope: global
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
--datastring-
A comma-separated list of filters for the
datafield of the profile document. To return all content usedata=*. To return a subset of content, usedata=<key>to retrieve content nested under the specified<key>. By default, the API returns nodatacontent. It is an error to specifydataas both the query parameter and the request body field.Repeatable: pass
--datamultiple times to supply more than one value --namestring- A query string used to match name-related fields in user profile documents.
Name-related fields are the user's
username,full_name, andemail. --sizenumber- The number of profiles to return.
--hintstring- 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
namefield query. --[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