Security privileges
editSecurity privileges
editThis section lists the privileges that you can assign to a role.
Cluster privileges
edit
|
All cluster administration operations, like snapshotting, node shutdown/restart, settings update, rerouting, or managing users and roles. |
|
Privileges to create snapshots for existing repositories. Can also list and view details on existing repositories and snapshots. |
|
Builds on |
|
All cross-cluster replication operations related to managing follower indices and auto-follow patterns. It also includes the authority to grant the privileges necessary to manage follower indices and auto-follow patterns. This privilege is necessary only on clusters that contain follower indices. |
|
All index lifecycle management operations related to managing policies |
|
All operations on index templates. |
|
All operations on ingest node pipelines. |
|
All machine learning operations, such as creating and deleting datafeeds, jobs, and model snapshots. Datafeeds that were created prior to version 6.2 or created when security features were disabled run as a system user with elevated privileges, including permission to read all indices. Newer datafeeds run with the security roles of the user who created or updated them. |
|
All operations on ingest pipelines. |
|
All rollup operations, including creating, starting, stopping and deleting rollup jobs. |
|
Enables the use of internal Elasticsearch APIs to initiate and manage SAML authentication on behalf of other users. |
|
All security-related operations such as CRUD operations on users and roles and cache clearing. |
|
All security-related operations on tokens that are generated by the Elasticsearch Token Service. |
|
All watcher operations, such as putting watches, executing, activate or acknowledging. Watches that were created prior to version 6.1 or created when the security features were disabled run as a system user with elevated privileges, including permission to read and write all indices. Newer watches run with the security roles of the user who created or updated them. |
|
All cluster read-only operations, like cluster health and state, hot threads, node info, node and cluster stats, and pending cluster tasks. |
|
All read only machine learning operations, such as getting information about datafeeds, jobs, model snapshots, or results. |
|
All read only rollup operations, such as viewing the list of historical and currently running rollup jobs and their capabilities. |
|
All read only watcher operations, such as getting a watch and watcher stats. |
|
All read only cross-cluster replication operations, such as getting information about indices and metadata for leader indices in the cluster. It also includes the authority to check whether users have the appropriate privileges to follow leader indices. This privilege is necessary only on clusters that contain leader indices. |
|
All read only index lifecycle management operations, such as getting policies and checking the status of index lifecycle management |
|
All privileges necessary for a transport client to connect. Required by the remote cluster to enable Cross Cluster Search. |
Indices privileges
edit
|
Any action on an index |
|
Privilege to index documents. Also grants access to the update mapping action. This privilege does not restrict the index operation to the creation of documents but instead restricts API use to the index API. The index API allows a user to overwrite a previously indexed document. |
|
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 |
|
Privilege to delete documents. |
|
Privilege to delete an index. |
|
Privilege to index and update documents. Also grants access to the update mapping action. |
|
All |
|
All actions that are required to manage the lifecycle of a follower index, which includes creating a follower index, closing it, and converting it to a regular index. This privilege is necessary only on clusters that contain follower indices. |
|
All index lifecycle management operations relating to managing the execution of policies of an index This includes operations like retrying policies, and removing a policy from an index. |
|
All actions that are required to manage the lifecycle of a leader index, which includes forgetting a follower. This privilege is necessary only on clusters that contain leader indices. |
|
All actions that are required for monitoring (recovery, segments info, index stats and status). |
|
Read only access to actions (count, explain, get, mget, get indexed scripts, more like this, multi percolate/search/termvector, percolate, scroll, clear_scroll, search, suggest, tv). |
|
Read only access to the search action from a remote cluster. |
|
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 Kibana users. |
|
Privilege to perform all write operations to documents, which includes the permission to index, update, and delete documents as well as performing bulk operations. Also grants access to the update mapping action. |
Run as privilege
editThe run_as
permission enables an authenticated user to submit requests on
behalf of another user. The value can be a user name or a comma-separated list
of user names. (You can also specify users as an array of strings or a YAML
sequence.) For more information, see
Submitting Requests on Behalf of Other Users.
Application privileges
editApplication privileges are managed within Elasticsearch and can be retrieved with the has privileges API and the get application privileges API. They do not, however, grant access to any actions or resources within Elasticsearch. Their purpose is to enable applications to represent and store their own privilege models within Elasticsearch roles.
To create application privileges, use the add application privileges API. You can then associate these application privileges with roles, as described in Defining roles.