Skip to content

[ILM][DOCS] Update ILM API authorization docs #36749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2018
Merged

[ILM][DOCS] Update ILM API authorization docs #36749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a99b534
[ILM][DOCS] Update ILM API authorization docs
talevy Dec 18, 2018
7f4187d
update
talevy Dec 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/delete-lifecycle.asciidoc
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions docs/reference/ilm/apis/ilm-index-mgt-privilege.asciidoc
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion docs/reference/ilm/apis/move-to-step.asciidoc
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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