Skip to content

Commit 7296e6c

Browse files
committed
wip
1 parent eac2a01 commit 7296e6c

File tree

4 files changed

+27
-12
lines changed

4 files changed

+27
-12
lines changed

docs/reference/rest-api/security/bulk-create-roles.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ They have no effect for remote clusters configured with the <<remote-clusters-ce
103103
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
104104
in this entry apply.
105105
`privileges`(required)::: (list) The cluster level privileges that the owners of the role
106-
have in the specified clusters.
106+
have in the specified clusters. Note - only a subset of the cluster privileges are supported for remote clusters.
107+
The <<security-api-get-builtin-privileges-request, builtin privileges API>> can be used to determine
108+
which privileges are allowed per version.
107109
108110
109111
For more information, see <<defining-roles>>.

docs/reference/rest-api/security/create-roles.asciidoc

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,9 @@ They have no effect for remote clusters configured with the <<remote-clusters-ce
105105
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
106106
in this entry apply.
107107
`privileges`(required)::: (list) The cluster level privileges that the owners of the role
108-
have in the specified clusters.
108+
have in the specified clusters. Note - only a subset of the cluster privileges are supported for remote clusters.
109+
The <<security-api-get-builtin-privileges-request, builtin privileges API>> can be used to determine
110+
which privileges are allowed per version.
109111

110112
For more information, see <<defining-roles>>.
111113

@@ -176,21 +178,29 @@ POST /_security/role/cli_or_drivers_minimal
176178
--------------------------------------------------
177179
// end::sql-queries-permission[]
178180

179-
The following example configures a role with remote indices privileges on a remote cluster:
181+
The following example configures a role with remote indices and remote cluster privileges for a remote cluster:
180182
[source,console]
181183
--------------------------------------------------
182-
POST /_security/role/role_with_remote_indices
184+
POST /_security/role/only_remote_access_role
183185
{
184186
"remote_indices": [
185187
{
186-
"clusters": [ "my_remote" ], <1>
188+
"clusters": ["my_remote"], <1>
187189
"names": ["logs*"], <2>
188190
"privileges": ["read", "read_cross_cluster", "view_index_metadata"] <3>
189191
}
192+
],
193+
"remote_cluster": [
194+
{
195+
"clusters": ["my_remote"], <1>
196+
"privileges": ["monitor_stats"] <4>
197+
}
190198
]
191199
}
192200
--------------------------------------------------
193201

194-
<1> The remote indices privileges apply to remote cluster with the alias `my_remote`.
195-
<2> Privileges are granted for indices matching pattern `logs*` on the remote cluster ( `my_remote`).
202+
<1> The remote indices and remote cluster privileges apply to remote cluster with the alias `my_remote`.
203+
<2> Privileges are granted for indices matching pattern `logs*` on the remote cluster (`my_remote`).
196204
<3> The actual <<privileges-list-indices,index privileges>> granted for `logs*` on `my_remote`.
205+
<4> The actual <<privileges-list-cluster,cluster privileges>> granted for `my_remote`.
206+
Note - only a subset of the cluster privileges are supported for remote clusters.

docs/reference/security/authorization/managing-roles.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,12 +249,10 @@ The following describes the structure of a remote cluster permissions entry:
249249
<<api-multi-index,wildcards>> and <<regexp-syntax,regular expressions>>.
250250
This field is required.
251251
<2> The cluster level privileges for the remote cluster. The allowed values here are a subset of the
252-
<<privileges-list-cluster,cluster privileges>>. This field is required.
252+
<<privileges-list-cluster,cluster privileges>>.
253+
The <<security-api-get-builtin-privileges-request, builtin privileges API>> can be used to determine
254+
which privileges are allowed here. This field is required.
253255

254-
The `monitor_enrich` privilege for remote clusters was introduced in version
255-
8.15.0. Currently, this is the only privilege available for remote clusters and
256-
is required to enable users to use the `ENRICH` keyword in ES|QL queries across
257-
clusters.
258256

259257
==== Example
260258

docs/reference/security/authorization/privileges.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,11 @@ Privileges to list and view details on existing repositories and snapshots.
250250
+
251251
This privilege is not available in {serverless-full}.
252252

253+
`monitor_stats`::
254+
Privileges to list and view details of stats.
255+
+
256+
This privilege is not available in {serverless-full}.
257+
253258
`monitor_text_structure`::
254259
All read-only operations related to the <<find-structure,find structure API>>.
255260
+

0 commit comments

Comments
 (0)