stack es security put-role cli command

elastic stack es security put-role --name <name> [options]
		

Create or update roles.

--name string required

The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.

--[no-]refresh

If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

--applications string[]

A list of application privilege entries.

--cluster string[]

A list of cluster privileges. These privileges define the cluster-level actions for users with this role.

--indices string[]

A list of indices permissions entries.

--metadata string

Optional metadata. Within the metadata object, keys that begin with an underscore (_) are reserved for system use.

--run-as string[]

A list of users that the owners of this role can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.

--description string

Optional description of the role descriptor

--transient-metadata string

Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If enabled is false, the role is ignored, but is still listed in the response from the authenticate API.

--input-file string

path to a JSON file to use as command input

-V --[no-]version

Print the Elastic CLI version

--config-file string

path to a config file (default: ~/.elasticrc.yml)

--use-context string

override the active context from the config file

--command-profile string

restrict available commands to a deployment profile (serverless, stack, default)

--[no-]json

output as JSON

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--[no-]dry-run

validate all inputs and exit without performing any action (preview changes without applying them)