1
- [role="xpack"]
2
1
[[security-privileges]]
3
2
=== Security privileges
3
+ :frontmatter-description: A list of privileges that can be assigned to user roles.
4
+ :frontmatter-tags-products: [elasticsearch]
5
+ :frontmatter-tags-content-type: [reference]
6
+ :frontmatter-tags-user-goals: [secure]
4
7
5
8
This section lists the privileges that you can assign to a role.
6
9
@@ -19,31 +22,37 @@ See <<delete-async-search,delete async search>> API for more informations.
19
22
`create_snapshot`::
20
23
Privileges to create snapshots for existing repositories. Can also list and view
21
24
details on existing repositories and snapshots.
25
+ +
26
+ This privilege is not available in {serverless-full}.
22
27
23
28
`cross_cluster_replication`::
24
29
Privileges to connect to <<remote-clusters-api-key,remote clusters configured with the API key based model>>
25
30
for cross-cluster replication.
26
31
+
27
32
--
33
+ This privilege is not available in {serverless-full}.
34
+
28
35
NOTE: This privilege should _not_ be directly granted. It is used internally by
29
36
<<security-api-create-cross-cluster-api-key>> and <<security-api-update-cross-cluster-api-key>>
30
37
to manage cross-cluster API keys.
31
-
32
38
--
33
39
34
40
`cross_cluster_search`::
35
41
Privileges to connect to <<remote-clusters-api-key,remote clusters configured with the API key based model>>
36
42
for cross-cluster search.
37
43
+
38
44
--
45
+ This privilege is not available in {serverless-full}.
46
+
39
47
NOTE: This privilege should _not_ be directly granted. It is used internally by
40
48
<<security-api-create-cross-cluster-api-key>> and <<security-api-update-cross-cluster-api-key>>
41
49
to manage cross-cluster API keys.
42
-
43
50
--
44
51
45
52
`grant_api_key`::
46
53
Privileges to create {es} API keys on behalf of other users.
54
+ +
55
+ This privilege is not available in {serverless-full}.
47
56
48
57
`manage`::
49
58
Builds on `monitor` and adds cluster operations that change values in the cluster.
@@ -73,14 +82,37 @@ owned by other users.
73
82
74
83
--
75
84
85
+ `manage_autoscaling`::
86
+ All operations related to managing autoscaling policies.
87
+ +
88
+ This privilege is not available in {serverless-full}.
89
+
76
90
`manage_ccr`::
77
91
All {ccr} operations related to managing follower indices and auto-follow
78
92
patterns. It also includes the authority to grant the privileges necessary to
79
93
manage follower indices and auto-follow patterns. This privilege is necessary
80
94
only on clusters that contain follower indices.
95
+ +
96
+ This privilege is not available in {serverless-full}.
97
+
98
+ `manage_data_frame_transforms`::
99
+ All operations related to managing {transforms}.
100
+ deprecated[7.5] Use `manage_transform` instead.
101
+ +
102
+ This privilege is not available in {serverless-full}.
103
+
104
+ `manage_data_stream_global_retention`::
105
+ All operations related to managing the data stream global retention settings.
106
+ +
107
+ This privilege is not available in {serverless-full}.
108
+
109
+ `manage_enrich`::
110
+ All operations related to managing and executing enrich policies.
81
111
82
112
`manage_ilm`::
83
- All {Ilm} operations related to managing policies.
113
+ All {ilm} operations related to managing policies.
114
+ +
115
+ This privilege is not available in {serverless-full}.
84
116
85
117
`manage_index_templates`::
86
118
All operations on index templates.
@@ -112,6 +144,8 @@ Enables the use of {es} APIs
112
144
<<security-api-oidc-authenticate,OpenID connect authenticate>>, and
113
145
<<security-api-oidc-logout,OpenID connect logout>>)
114
146
to initiate and manage OpenID Connect authentication on behalf of other users.
147
+ +
148
+ This privilege is not available in {serverless-full}.
115
149
116
150
`manage_own_api_key`::
117
151
All security-related operations on {es} API keys that are owned by the current
@@ -129,10 +163,14 @@ All operations on ingest pipelines.
129
163
`manage_rollup`::
130
164
All rollup operations, including creating, starting, stopping and deleting
131
165
rollup jobs.
166
+ +
167
+ This privilege is not available in {serverless-full}.
132
168
133
169
`manage_saml`::
134
170
Enables the use of internal {es} APIs to initiate and manage SAML authentication
135
171
on behalf of other users.
172
+ +
173
+ This privilege is not available in {serverless-full}.
136
174
137
175
`manage_search_application`::
138
176
All CRUD operations on <<search-application-apis, search applications>>.
@@ -152,46 +190,45 @@ All security-related operations on {es} service accounts including
152
190
<<security-api-get-service-accounts>>,
153
191
<<security-api-create-service-token>>, <<security-api-delete-service-token>>,
154
192
and <<security-api-get-service-credentials>>.
193
+ +
194
+ This privilege is not available in {serverless-full}.
155
195
156
196
`manage_slm`::
157
197
All {slm} ({slm-init}) actions, including creating and updating policies and
158
198
starting and stopping {slm-init}.
199
+ +
200
+ This privilege is not available in {serverless-full}.
159
201
160
202
`manage_token`::
161
203
All security-related operations on tokens that are generated by the {es} Token
162
204
Service.
205
+ +
206
+ This privilege is not available in {serverless-full}.
163
207
164
208
`manage_transform`::
165
209
All operations related to managing {transforms}.
166
210
167
- `manage_autoscaling`::
168
- All operations related to managing autoscaling policies.
169
-
170
- `manage_data_frame_transforms`::
171
- All operations related to managing {transforms}.
172
- deprecated[7.5] Use `manage_transform` instead.
173
-
174
- `manage_enrich`::
175
- All operations related to managing and executing enrich policies.
176
-
177
- `manage_data_stream_global_retention`::
178
- All operations related to managing the data stream global retention settings.
179
-
180
211
`manage_watcher`::
181
212
All watcher operations, such as putting watches, executing, activate or acknowledging.
182
213
+
183
214
--
215
+ This privilege is not available in {serverless-full}.
216
+
184
217
NOTE: Watches that were created prior to version 6.1 or created when the
185
218
{security-features} were disabled run as a system user with elevated privileges,
186
219
including permission to read and write all indices. Newer watches run with the
187
220
security roles of the user who created or updated them.
188
-
189
221
--
190
222
191
223
`monitor`::
192
224
All cluster read-only operations, like cluster health and state, hot threads,
193
225
node info, node and cluster stats, and pending cluster tasks.
194
226
227
+ `monitor_data_stream_global_retention`::
228
+ Allows the retrieval of the data stream global retention settings.
229
+ +
230
+ This privilege is not available in {serverless-full}.
231
+
195
232
`monitor_enrich`::
196
233
All read-only operations related to managing and executing enrich policies.
197
234
@@ -205,38 +242,49 @@ model snapshots, or results.
205
242
`monitor_rollup`::
206
243
All read-only rollup operations, such as viewing the list of historical and
207
244
currently running rollup jobs and their capabilities.
245
+ +
246
+ This privilege is not available in {serverless-full}.
208
247
209
248
`monitor_snapshot`::
210
249
Privileges to list and view details on existing repositories and snapshots.
250
+ +
251
+ This privilege is not available in {serverless-full}.
211
252
212
253
`monitor_text_structure`::
213
254
All read-only operations related to the <<find-structure,find structure API>>.
255
+ +
256
+ This privilege is not available in {serverless-full}.
214
257
215
258
`monitor_transform`::
216
259
All read-only operations related to {transforms}.
217
260
218
- `monitor_data_stream_global_retention`::
219
- Allows the retrieval of the data stream global retention settings.
220
-
221
261
`monitor_watcher`::
222
262
All read-only watcher operations, such as getting a watch and watcher stats.
263
+ +
264
+ This privilege is not available in {serverless-full}.
223
265
224
266
`read_ccr`::
225
267
All read-only {ccr} operations, such as getting information about indices and
226
268
metadata for leader indices in the cluster. It also includes the authority to
227
269
check whether users have the appropriate privileges to follow leader indices.
228
270
This privilege is necessary only on clusters that contain leader indices.
271
+ +
272
+ This privilege is not available in {serverless-full}.
229
273
230
274
`read_ilm`::
231
275
All read-only {Ilm} operations, such as getting policies and checking the
232
276
status of {Ilm}
277
+ +
278
+ This privilege is not available in {serverless-full}.
233
279
234
280
`read_pipeline`::
235
281
Read-only access to ingest pipline (get, simulate).
236
282
237
283
`read_slm`::
238
284
All read-only {slm-init} actions, such as getting policies and checking the
239
285
{slm-init} status.
286
+ +
287
+ This privilege is not available in {serverless-full}.
240
288
241
289
`read_security`::
242
290
All read-only security-related operations, such as getting users, user profiles,
@@ -247,6 +295,8 @@ on all {es} API keys.
247
295
`transport_client`::
248
296
All privileges necessary for a transport client to connect. Required by the remote
249
297
cluster to enable <<remote-clusters,{ccs}>>.
298
+ +
299
+ This privilege is not available in {serverless-full}.
250
300
251
301
[[privileges-list-indices]]
252
302
==== Indices privileges
@@ -320,16 +370,19 @@ Privileges to perform cross-cluster replication for indices located on
320
370
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
321
371
This privilege should only be used for
322
372
the `privileges` field of <<roles-remote-indices-priv,remote indices privileges>>.
373
+ +
374
+ This privilege is not available in {serverless-full}.
323
375
324
376
`cross_cluster_replication_internal`::
325
377
Privileges to perform supporting actions for cross-cluster replication from
326
378
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
327
379
+
328
380
--
381
+ This privilege is not available in {serverless-full}.
382
+
329
383
NOTE: This privilege should _not_ be directly granted. It is used internally by
330
384
<<security-api-create-cross-cluster-api-key>> and <<security-api-update-cross-cluster-api-key>>
331
385
to manage cross-cluster API keys.
332
-
333
386
--
334
387
335
388
`delete`::
@@ -356,24 +409,30 @@ All `monitor` privileges plus index and data stream administration (aliases,
356
409
analyze, cache clear, close, delete, exists, flush, mapping, open, field capabilities,
357
410
force merge, refresh, settings, search shards, validate query).
358
411
412
+ `manage_data_stream_lifecycle`::
413
+ All <<data-stream-lifecycle, Data stream lifecycle>> operations relating to reading and managing the built-in lifecycle of a data stream.
414
+ This includes operations such as adding and removing a lifecycle from a data stream.
415
+
359
416
`manage_follow_index`::
360
417
All actions that are required to manage the lifecycle of a follower index, which
361
418
includes creating a follower index, closing it, and converting it to a regular
362
419
index. This privilege is necessary only on clusters that contain follower indices.
420
+ +
421
+ This privilege is not available in {serverless-full}.
363
422
364
423
`manage_ilm`::
365
424
All {Ilm} operations relating to managing the execution of policies of an index
366
425
or data stream. This includes operations such as retrying policies and removing
367
426
a policy from an index or data stream.
368
-
369
- `manage_data_stream_lifecycle`::
370
- All <<data-stream-lifecycle, Data stream lifecycle>> operations relating to reading and managing the built-in lifecycle of a data stream.
371
- This includes operations such as adding and removing a lifecycle from a data stream.
427
+ +
428
+ This privilege is not available in {serverless-full}.
372
429
373
430
`manage_leader_index`::
374
431
All actions that are required to manage the lifecycle of a leader index, which
375
432
includes <<ccr-post-forget-follower,forgetting a follower>>. This
376
433
privilege is necessary only on clusters that contain leader indices.
434
+ +
435
+ This privilege is not available in {serverless-full}.
377
436
378
437
`monitor`::
379
438
All actions that are required for monitoring (recovery, segments info, index
@@ -386,6 +445,8 @@ clear_scroll, search, suggest, tv).
386
445
387
446
`read_cross_cluster`::
388
447
Read-only access to the search action from a <<remote-clusters,remote cluster>>.
448
+ +
449
+ This privilege is not available in {serverless-full}.
389
450
390
451
`view_index_metadata`::
391
452
Read-only access to index and data stream metadata (aliases, exists,
@@ -411,6 +472,8 @@ of user names. (You can also specify users as an array of strings or a YAML
411
472
sequence.) For more information, see
412
473
<<run-as-privilege>>.
413
474
475
+ This privilege is not available in {serverless-full}.
476
+
414
477
[[application-privileges]]
415
478
==== Application privileges
416
479
0 commit comments