stack es security put-role-mapping cli command

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

Create or update role mappings.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--name string required

The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.

--refresh enum

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.

Values: true, false, wait_for

--enabled

Mappings that have enabled set to false are ignored when role mapping is performed.

--metadata string

Additional metadata that helps define which roles are assigned to each user. Within the metadata object, keys beginning with _ are reserved for system usage.

--roles string[]

A list of role names that are granted to the users that match the role mapping rules. Exactly one of roles or role_templates must be specified.

Repeatable: pass --roles multiple times to supply more than one value

--role-templates string[]

A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules. Exactly one of roles or role_templates must be specified.

Repeatable: pass --role-templates multiple times to supply more than one value

--rules string

The rules that determine which users should be matched by the mapping. A rule is a logical condition that is expressed by using a JSON DSL.

--run-as string[]

Repeatable: pass --run-as multiple times to supply more than one value

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

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)

--no-validate

skip input validation and send the request as-is

--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}}")

--json

output as JSON