Skip to content

Commit d51a04c

Browse files
authored
[DOCS] Add operator privileges to APIs and settings (#69903)
1 parent 74feca2 commit d51a04c

File tree

7 files changed

+41
-15
lines changed

7 files changed

+41
-15
lines changed

docs/reference/autoscaling/apis/delete-autoscaling-policy.asciidoc

+6-3
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,12 @@ DELETE /_autoscaling/policy/<name>
3737
[[autoscaling-delete-autoscaling-policy-prereqs]]
3838
==== {api-prereq-title}
3939

40-
* If the {es} {security-features} are enabled, you must have
41-
`manage_autoscaling` cluster privileges. For more information, see
42-
<<security-privileges>>.
40+
* If the {es} {security-features} are enabled, you must have the
41+
`manage_autoscaling` <<privileges-list-cluster,cluster privilege>> to use this
42+
API.
43+
44+
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
45+
users can use this API.
4346

4447
[[autoscaling-delete-autoscaling-policy-desc]]
4548
==== {api-description-title}

docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc

+6-3
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,12 @@ DELETE /_autoscaling/policy/name
3939
[[autoscaling-put-autoscaling-policy-prereqs]]
4040
==== {api-prereq-title}
4141

42-
* If the {es} {security-features} are enabled, you must have
43-
`manage_autoscaling` cluster privileges. For more information, see
44-
<<security-privileges>>.
42+
* If the {es} {security-features} are enabled, you must have the
43+
`manage_autoscaling` <<privileges-list-cluster,cluster privilege>> to use this
44+
API.
45+
46+
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
47+
users can use this API.
4548

4649
[[autoscaling-put-autoscaling-policy-desc]]
4750
==== {api-description-title}

docs/reference/cluster/voting-exclusions.asciidoc

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ Adds or removes master-eligible nodes from the
2323
* If the {es} {security-features} are enabled, you must have the `manage`
2424
<<privileges-list-cluster,cluster privilege>> to use this API.
2525

26+
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
27+
users can use this API.
28+
2629
[[voting-config-exclusions-api-desc]]
2730
==== {api-description-title}
2831

docs/reference/licensing/delete-license.asciidoc

+7-5
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ When your license expires, {xpack} operates in a degraded mode. For more
2020
information, see
2121
{kibana-ref}/managing-licenses.html#license-expiration[License expiration].
2222

23-
[discrete]
24-
==== Authorization
23+
[[delete-license-api-prereqs]]
24+
==== {api-prereq-title}
25+
26+
* If the {es} {security-features} are enabled, you must have the `manage`
27+
<<privileges-list-cluster,cluster privilege>> to use this API.
2528

26-
You must have `manage` cluster privileges to use this API.
27-
For more information, see
28-
<<security-privileges>>.
29+
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
30+
users can use this API.
2931

3032
[discrete]
3133
==== Examples

docs/reference/licensing/update-license.asciidoc

+6-3
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,16 @@ Updates the license for your {es} cluster.
1818
[[update-license-api-prereqs]]
1919
==== {api-prereq-title}
2020

21-
If {es} {security-features} are enabled, you need `manage` cluster privileges to
22-
install the license.
21+
* If {es} {security-features} are enabled, you need `manage`
22+
<<privileges-list-cluster,cluster privilege>> to install the license.
2323

24-
If {es} {security-features} are enabled and you are installing a gold or higher
24+
* If {es} {security-features} are enabled and you are installing a gold or higher
2525
license, you must enable TLS on the transport networking layer before you
2626
install the license. See <<configuring-tls>>.
2727

28+
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
29+
users can use this API.
30+
2831
[[update-license-api-desc]]
2932
==== {api-description-title}
3033

docs/reference/snapshot-restore/apis/repo-analysis-api.asciidoc

+10
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ POST /_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=1
3232

3333
`POST /_snapshot/<repository>/_analyze`
3434

35+
[[repo-analysis-api-prereqs]]
36+
==== {api-prereq-title}
37+
38+
* If the {es} {security-features} are enabled, you must have the `manage`
39+
<<privileges-list-cluster,cluster privilege>> to use this API. For more
40+
information, see <<security-privileges>>.
41+
42+
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
43+
users can use this API.
44+
3545
[[repo-analysis-api-desc]]
3646
==== {api-description-title}
3747

x-pack/docs/en/security/using-ip-filtering.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ NOTE: Elasticsearch installations are not designed to be publicly accessible
1717
=== Enabling IP filtering
1818

1919
The {es} {security-features} contain an access control feature that allows or
20-
rejects hosts, domains, or subnets.
20+
rejects hosts, domains, or subnets. If the
21+
<<operator-privileges,{operator-feature}>> is enabled, only operator users can
22+
update these settings.
2123

2224
You configure IP filtering by specifying the `xpack.security.transport.filter.allow` and
2325
`xpack.security.transport.filter.deny` settings in `elasticsearch.yml`. Allow rules

0 commit comments

Comments
 (0)