Skip to content

Commit 5c46a61

Browse files
talevytalevy
committed
[ILM][DOCS] Update ILM API authorization docs (#36749)
the `view_index_metadata` privilege. Now the ILM API authorization documentation mentions the need for these roles in more specific ways.
1 parent 8d32ae2 commit 5c46a61

12 files changed

+24
-14
lines changed

‎docs/reference/ilm/apis/delete-lifecycle.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3131

3232
==== Authorization
3333

34-
include::ilm-cluster-mgt-privilege.asciidoc[]
34+
You must have the `manage_ilm` cluster privilege to use this API.
35+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3536

3637
==== Examples
3738

‎docs/reference/ilm/apis/explain.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3232

3333
==== Authorization
3434

35-
include::ilm-index-mgt-privilege.asciidoc[]
35+
You must have the `view_index_metadata` or `manage_ilm` or both privileges on the indices
36+
being managed to use this API.
37+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3638

3739
==== Examples
3840

‎docs/reference/ilm/apis/get-lifecycle.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3131

3232
==== Authorization
3333

34-
include::ilm-cluster-mgt-privilege.asciidoc[]
34+
You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API.
35+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3536

3637
==== Examples
3738

‎docs/reference/ilm/apis/get-status.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
2727

2828
==== Authorization
2929

30-
include::ilm-cluster-mgt-privilege.asciidoc[]
30+
You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API.
31+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3132

3233
==== Examples
3334

‎docs/reference/ilm/apis/ilm-cluster-mgt-privilege.asciidoc

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎docs/reference/ilm/apis/ilm-index-mgt-privilege.asciidoc

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎docs/reference/ilm/apis/move-to-step.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
4040

4141
==== Authorization
4242

43-
include::ilm-index-mgt-privilege.asciidoc[]
43+
You must have the `manage_ilm` privileges on the indices being managed to use this API.
44+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
4445

4546
==== Examples
4647

‎docs/reference/ilm/apis/put-lifecycle.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3333

3434
==== Authorization
3535

36-
include::ilm-cluster-mgt-privilege.asciidoc[]
36+
You must have the `manage_ilm` cluster privilege to use this API. You must
37+
also have the `manage` index privilege on all indices being managed by `policy`.
38+
All operations executed by {Ilm} for a policy are executed as the user that
39+
put the latest version of a policy.
40+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3741

3842
==== Examples
3943

‎docs/reference/ilm/apis/remove-policy-from-index.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3131

3232
==== Authorization
3333

34-
include::ilm-cluster-mgt-privilege.asciidoc[]
34+
You must have the `manage_ilm` privileges on the indices being managed to use this API.
35+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3536

3637
==== Examples
3738

‎docs/reference/ilm/apis/retry-policy.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3131

3232
==== Authorization
3333

34-
include::ilm-index-mgt-privilege.asciidoc[]
34+
You must have the `manage_ilm` privileges on the indices being managed to use this API.
35+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3536

3637
==== Examples
3738

‎docs/reference/ilm/apis/start.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
2626

2727
==== Authorization
2828

29-
include::ilm-cluster-mgt-privilege.asciidoc[]
29+
You must have the `manage_ilm` cluster privilege to use this API.
30+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3031

3132
==== Examples
3233

‎docs/reference/ilm/apis/stop.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3131

3232
==== Authorization
3333

34-
include::ilm-cluster-mgt-privilege.asciidoc[]
34+
You must have the `manage_ilm` cluster privilege to use this API.
35+
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
3536

3637
==== Examples
3738

0 commit comments

Comments
 (0)