Skip to content

Commit

Permalink
[ILM][DOCS] Update ILM API authorization docs (#36749)
Browse files Browse the repository at this point in the history
the `view_index_metadata` privilege. Now the ILM API authorization
documentation mentions the need for these roles in more specific
ways.
  • Loading branch information
talevy authored Dec 18, 2018
1 parent 0b22ca3 commit 32ce124
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 14 deletions.
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/delete-lifecycle.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
4 changes: 3 additions & 1 deletion docs/reference/ilm/apis/explain.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/get-lifecycle.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/get-status.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/ilm/apis/ilm-cluster-mgt-privilege.asciidoc

This file was deleted.

2 changes: 0 additions & 2 deletions docs/reference/ilm/apis/ilm-index-mgt-privilege.asciidoc

This file was deleted.

3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/move-to-step.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
6 changes: 5 additions & 1 deletion docs/reference/ilm/apis/put-lifecycle.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/remove-policy-from-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/retry-policy.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/start.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/stop.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

==== Authorization

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

==== Examples

Expand Down

0 comments on commit 32ce124

Please sign in to comment.