Skip to content

Commit

Permalink
Update index privileges doc to include data streams (#59139) (#60170)
Browse files Browse the repository at this point in the history
  • Loading branch information
danhermann authored Jul 24, 2020
1 parent b7c9138 commit 8c5c24d
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions x-pack/docs/en/security/authorization/privileges.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ cluster to enable <<cross-cluster-configuring,Cross Cluster Search>>.

[horizontal]
`all`::
Any action on an index
Any action on an index or data stream.

`auto_configure`::
Permits auto-creation of indices and data streams. An auto-create action is the
Expand Down Expand Up @@ -204,15 +204,16 @@ privilege (and no higher privilege such as `index` or `write`), you must ensure
--

`create_index`::
Privilege to create an index. A create index request may contain aliases to be
added to the index once created. In that case the request requires the `manage`
privilege as well, on both the index and the aliases names.
Privilege to create an index or data stream. A create index request may contain
aliases to be added to the index once created. In that case the request
requires the `manage` privilege as well, on both the index and the aliases
names.

`delete`::
Privilege to delete documents.

`delete_index`::
Privilege to delete an index.
Privilege to delete an index or data stream.

`index`::
Privilege to index (overwriting included) and update documents.
Expand All @@ -227,9 +228,9 @@ Permits refresh, flush, synced flush and force merge index administration operat
No privilege to read or write index data or otherwise manage the index.

`manage`::
All `monitor` privileges plus index administration (aliases, analyze, cache clear,
close, delete, exists, flush, mapping, open, force merge, refresh, settings,
search shards, templates, validate).
All `monitor` privileges plus index and data stream administration (aliases,
analyze, cache clear, close, delete, exists, flush, mapping, open, force merge,
refresh, settings, search shards, templates, validate).

`manage_follow_index`::
All actions that are required to manage the lifecycle of a follower index, which
Expand All @@ -238,8 +239,8 @@ index. This privilege is necessary only on clusters that contain follower indice

`manage_ilm`::
All {Ilm} operations relating to managing the execution of policies of an index
This includes operations like retrying policies, and removing a policy
from an index.
or data stream. This includes operations such as retrying policies and removing
a policy from an index or data stream.

`manage_leader_index`::
All actions that are required to manage the lifecycle of a leader index, which
Expand All @@ -259,9 +260,10 @@ clear_scroll, search, suggest, tv).
Read-only access to the search action from a <<cross-cluster-configuring,remote cluster>>.

`view_index_metadata`::
Read-only access to index metadata (aliases, aliases exists, get index, exists, field mappings,
mappings, search shards, type exists, validate, warmers, settings, ilm). This
privilege is primarily available for use by {kib} users.
Read-only access to index and data stream metadata (aliases, aliases exists,
get index, get data stream, exists, field mappings, mappings, search shards,
type exists, validate, warmers, settings, ilm). This privilege is available
for use primarily by {kib} users.

`write`::
Privilege to perform all write operations to documents, which includes the
Expand Down

0 comments on commit 8c5c24d

Please sign in to comment.