stack es security bulk-update-api-keys cli command
Auth required
elastic stack es security bulk-update-api-keys --ids <ids> [options]
Bulk update API keys.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--idsstringrequired-
The API key identifiers.
Repeatable: pass
--idsmultiple times to supply more than one value --expirationstring- Expiration time for the API keys. By default, API keys never expire. This property can be omitted to leave the value unchanged.
--metadatastring- Arbitrary nested metadata to associate with the API keys.
Within the
metadataobject, top-level keys beginning with an underscore (_) are reserved for system usage. Any information specified with this parameter fully replaces metadata previously associated with the API key. --role-descriptorsstring- The role descriptors to assign to the API keys.
An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.
You can assign new privileges by specifying them in this parameter.
To remove assigned privileges, supply the
role_descriptorsparameter as an empty object{}. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply therole_descriptorsparameter. The structure of a role descriptor is the same as the request for the create API keys API. --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