stack es security grant-api-key cli command
Auth required
elastic stack es security grant-api-key \
--api-key <api-key> \
--grant-type <grant-type> \
[options]
Grant an API key.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--api-keystringrequired- The API key.
--grant-typeenumrequired-
The type of grant. Supported grant types are:
access_token,password.Values: access_token, password
--refreshenum-
If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes.
Values: true, false, wait_for
--access-tokenstring- The user's access token.
If you specify the
access_tokengrant type, this parameter is required. It is not valid with other grant types. --usernamestring- The user name that identifies the user.
If you specify the
passwordgrant type, this parameter is required. It is not valid with other grant types. --passwordstring- The user's password.
If you specify the
passwordgrant type, this parameter is required. It is not valid with other grant types. --run-asstring- The name of the user to be impersonated.
--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 --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. --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
--dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--json-
output as JSON