Skip to content

Commit 748dbd5

Browse files
authored
[DOCS] Add serverless details in Elasticsearch security privileges (#109718)
1 parent 9087fc5 commit 748dbd5

File tree

1 file changed

+89
-26
lines changed

1 file changed

+89
-26
lines changed

docs/reference/security/authorization/privileges.asciidoc

Lines changed: 89 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
[role="xpack"]
21
[[security-privileges]]
32
=== 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]
47

58
This section lists the privileges that you can assign to a role.
69

@@ -19,31 +22,37 @@ See <<delete-async-search,delete async search>> API for more informations.
1922
`create_snapshot`::
2023
Privileges to create snapshots for existing repositories. Can also list and view
2124
details on existing repositories and snapshots.
25+
+
26+
This privilege is not available in {serverless-full}.
2227

2328
`cross_cluster_replication`::
2429
Privileges to connect to <<remote-clusters-api-key,remote clusters configured with the API key based model>>
2530
for cross-cluster replication.
2631
+
2732
--
33+
This privilege is not available in {serverless-full}.
34+
2835
NOTE: This privilege should _not_ be directly granted. It is used internally by
2936
<<security-api-create-cross-cluster-api-key>> and <<security-api-update-cross-cluster-api-key>>
3037
to manage cross-cluster API keys.
31-
3238
--
3339

3440
`cross_cluster_search`::
3541
Privileges to connect to <<remote-clusters-api-key,remote clusters configured with the API key based model>>
3642
for cross-cluster search.
3743
+
3844
--
45+
This privilege is not available in {serverless-full}.
46+
3947
NOTE: This privilege should _not_ be directly granted. It is used internally by
4048
<<security-api-create-cross-cluster-api-key>> and <<security-api-update-cross-cluster-api-key>>
4149
to manage cross-cluster API keys.
42-
4350
--
4451

4552
`grant_api_key`::
4653
Privileges to create {es} API keys on behalf of other users.
54+
+
55+
This privilege is not available in {serverless-full}.
4756

4857
`manage`::
4958
Builds on `monitor` and adds cluster operations that change values in the cluster.
@@ -73,14 +82,37 @@ owned by other users.
7382

7483
--
7584

85+
`manage_autoscaling`::
86+
All operations related to managing autoscaling policies.
87+
+
88+
This privilege is not available in {serverless-full}.
89+
7690
`manage_ccr`::
7791
All {ccr} operations related to managing follower indices and auto-follow
7892
patterns. It also includes the authority to grant the privileges necessary to
7993
manage follower indices and auto-follow patterns. This privilege is necessary
8094
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.
81111

82112
`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}.
84116

85117
`manage_index_templates`::
86118
All operations on index templates.
@@ -112,6 +144,8 @@ Enables the use of {es} APIs
112144
<<security-api-oidc-authenticate,OpenID connect authenticate>>, and
113145
<<security-api-oidc-logout,OpenID connect logout>>)
114146
to initiate and manage OpenID Connect authentication on behalf of other users.
147+
+
148+
This privilege is not available in {serverless-full}.
115149

116150
`manage_own_api_key`::
117151
All security-related operations on {es} API keys that are owned by the current
@@ -129,10 +163,14 @@ All operations on ingest pipelines.
129163
`manage_rollup`::
130164
All rollup operations, including creating, starting, stopping and deleting
131165
rollup jobs.
166+
+
167+
This privilege is not available in {serverless-full}.
132168

133169
`manage_saml`::
134170
Enables the use of internal {es} APIs to initiate and manage SAML authentication
135171
on behalf of other users.
172+
+
173+
This privilege is not available in {serverless-full}.
136174

137175
`manage_search_application`::
138176
All CRUD operations on <<search-application-apis, search applications>>.
@@ -152,46 +190,45 @@ All security-related operations on {es} service accounts including
152190
<<security-api-get-service-accounts>>,
153191
<<security-api-create-service-token>>, <<security-api-delete-service-token>>,
154192
and <<security-api-get-service-credentials>>.
193+
+
194+
This privilege is not available in {serverless-full}.
155195

156196
`manage_slm`::
157197
All {slm} ({slm-init}) actions, including creating and updating policies and
158198
starting and stopping {slm-init}.
199+
+
200+
This privilege is not available in {serverless-full}.
159201

160202
`manage_token`::
161203
All security-related operations on tokens that are generated by the {es} Token
162204
Service.
205+
+
206+
This privilege is not available in {serverless-full}.
163207

164208
`manage_transform`::
165209
All operations related to managing {transforms}.
166210

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-
180211
`manage_watcher`::
181212
All watcher operations, such as putting watches, executing, activate or acknowledging.
182213
+
183214
--
215+
This privilege is not available in {serverless-full}.
216+
184217
NOTE: Watches that were created prior to version 6.1 or created when the
185218
{security-features} were disabled run as a system user with elevated privileges,
186219
including permission to read and write all indices. Newer watches run with the
187220
security roles of the user who created or updated them.
188-
189221
--
190222

191223
`monitor`::
192224
All cluster read-only operations, like cluster health and state, hot threads,
193225
node info, node and cluster stats, and pending cluster tasks.
194226

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+
195232
`monitor_enrich`::
196233
All read-only operations related to managing and executing enrich policies.
197234

@@ -205,38 +242,49 @@ model snapshots, or results.
205242
`monitor_rollup`::
206243
All read-only rollup operations, such as viewing the list of historical and
207244
currently running rollup jobs and their capabilities.
245+
+
246+
This privilege is not available in {serverless-full}.
208247

209248
`monitor_snapshot`::
210249
Privileges to list and view details on existing repositories and snapshots.
250+
+
251+
This privilege is not available in {serverless-full}.
211252

212253
`monitor_text_structure`::
213254
All read-only operations related to the <<find-structure,find structure API>>.
255+
+
256+
This privilege is not available in {serverless-full}.
214257

215258
`monitor_transform`::
216259
All read-only operations related to {transforms}.
217260

218-
`monitor_data_stream_global_retention`::
219-
Allows the retrieval of the data stream global retention settings.
220-
221261
`monitor_watcher`::
222262
All read-only watcher operations, such as getting a watch and watcher stats.
263+
+
264+
This privilege is not available in {serverless-full}.
223265

224266
`read_ccr`::
225267
All read-only {ccr} operations, such as getting information about indices and
226268
metadata for leader indices in the cluster. It also includes the authority to
227269
check whether users have the appropriate privileges to follow leader indices.
228270
This privilege is necessary only on clusters that contain leader indices.
271+
+
272+
This privilege is not available in {serverless-full}.
229273

230274
`read_ilm`::
231275
All read-only {Ilm} operations, such as getting policies and checking the
232276
status of {Ilm}
277+
+
278+
This privilege is not available in {serverless-full}.
233279

234280
`read_pipeline`::
235281
Read-only access to ingest pipline (get, simulate).
236282

237283
`read_slm`::
238284
All read-only {slm-init} actions, such as getting policies and checking the
239285
{slm-init} status.
286+
+
287+
This privilege is not available in {serverless-full}.
240288

241289
`read_security`::
242290
All read-only security-related operations, such as getting users, user profiles,
@@ -247,6 +295,8 @@ on all {es} API keys.
247295
`transport_client`::
248296
All privileges necessary for a transport client to connect. Required by the remote
249297
cluster to enable <<remote-clusters,{ccs}>>.
298+
+
299+
This privilege is not available in {serverless-full}.
250300

251301
[[privileges-list-indices]]
252302
==== Indices privileges
@@ -320,16 +370,19 @@ Privileges to perform cross-cluster replication for indices located on
320370
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
321371
This privilege should only be used for
322372
the `privileges` field of <<roles-remote-indices-priv,remote indices privileges>>.
373+
+
374+
This privilege is not available in {serverless-full}.
323375

324376
`cross_cluster_replication_internal`::
325377
Privileges to perform supporting actions for cross-cluster replication from
326378
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
327379
+
328380
--
381+
This privilege is not available in {serverless-full}.
382+
329383
NOTE: This privilege should _not_ be directly granted. It is used internally by
330384
<<security-api-create-cross-cluster-api-key>> and <<security-api-update-cross-cluster-api-key>>
331385
to manage cross-cluster API keys.
332-
333386
--
334387

335388
`delete`::
@@ -356,24 +409,30 @@ All `monitor` privileges plus index and data stream administration (aliases,
356409
analyze, cache clear, close, delete, exists, flush, mapping, open, field capabilities,
357410
force merge, refresh, settings, search shards, validate query).
358411

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+
359416
`manage_follow_index`::
360417
All actions that are required to manage the lifecycle of a follower index, which
361418
includes creating a follower index, closing it, and converting it to a regular
362419
index. This privilege is necessary only on clusters that contain follower indices.
420+
+
421+
This privilege is not available in {serverless-full}.
363422

364423
`manage_ilm`::
365424
All {Ilm} operations relating to managing the execution of policies of an index
366425
or data stream. This includes operations such as retrying policies and removing
367426
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}.
372429

373430
`manage_leader_index`::
374431
All actions that are required to manage the lifecycle of a leader index, which
375432
includes <<ccr-post-forget-follower,forgetting a follower>>. This
376433
privilege is necessary only on clusters that contain leader indices.
434+
+
435+
This privilege is not available in {serverless-full}.
377436

378437
`monitor`::
379438
All actions that are required for monitoring (recovery, segments info, index
@@ -386,6 +445,8 @@ clear_scroll, search, suggest, tv).
386445

387446
`read_cross_cluster`::
388447
Read-only access to the search action from a <<remote-clusters,remote cluster>>.
448+
+
449+
This privilege is not available in {serverless-full}.
389450

390451
`view_index_metadata`::
391452
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
411472
sequence.) For more information, see
412473
<<run-as-privilege>>.
413474

475+
This privilege is not available in {serverless-full}.
476+
414477
[[application-privileges]]
415478
==== Application privileges
416479

0 commit comments

Comments
 (0)