diff --git a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc index a7adad79185..dd394697185 100644 --- a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc @@ -21,8 +21,12 @@ experimental[] [[ml-delete-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `machine_learning_admin` built-in role to use this API. For more -information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: + +* `machine_learning_admin` +* `kibana_user` (UI only) + +For more information, see <> and <>. [[ml-delete-dfanalytics-path-params]] diff --git a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc index f2fd703dd83..086c093927b 100644 --- a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc @@ -22,8 +22,12 @@ experimental[] [[ml-delete-inference-prereq]] ==== {api-prereq-title} -* You must have `machine_learning_admin` built-in role to use this API. For more -information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: + +* `machine_learning_admin` +* `kibana_user` (UI only) + +For more information, see <> and <>. [[ml-delete-inference-path-params]] @@ -64,4 +68,3 @@ The API returns the following result: } ---- - diff --git a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc index bcba82992d1..0f4f5b222e5 100644 --- a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc @@ -22,8 +22,11 @@ experimental[] [[ml-evaluate-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `monitor_ml` privilege to use this API. For more -information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following privileges: + +* cluster: `monitor_ml` + +For more information, see <> and <>. [[ml-evaluate-dfanalytics-desc]] @@ -426,4 +429,4 @@ predictions associated with the class. <4> The number of cats in the dataset that are correctly identified as cats. <5> The number of cats in the dataset that are incorrectly classified as dogs. <6> The number of documents that are classified as a class that is not listed as -a `predicted_class`. \ No newline at end of file +a `predicted_class`. diff --git a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc index 980e2aa7d3f..f2f570cadaf 100644 --- a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc @@ -28,8 +28,11 @@ experimental[] [[ml-explain-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `monitor_ml` privilege to use this API. For more -information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following privileges: + +* cluster: `monitor_ml` + +For more information, see <> and <>. [[ml-explain-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index 91c022e9b64..508e1072349 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -28,8 +28,11 @@ experimental[] [[ml-get-dfanalytics-stats-prereq]] ==== {api-prereq-title} -* You must have `monitor_ml` privilege to use this API. For more -information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following privileges: + +* cluster: `monitor_ml` + +For more information, see <> and <>. [[ml-get-dfanalytics-stats-path-params]] diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc index 816135fb622..dfcf6475912 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc @@ -27,8 +27,11 @@ experimental[] [[ml-get-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `monitor_ml` privilege to use this API. For more information, -see <> and <>. +If the {es} {security-features} are enabled, you must have the following privileges: + +* cluster: `monitor_ml` + +For more information, see <> and <>. [[ml-get-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc index a31dc071640..8bc88208433 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc @@ -29,8 +29,11 @@ experimental[] [[ml-get-inference-stats-prereq]] ==== {api-prereq-title} -* You must have `monitor_ml` privilege to use this API. For more information, -see <> and <>. +Required privileges which should be added to a custom role: + +* cluster: `monitor_ml` + +For more information, see <> and <>. [[ml-get-inference-stats-desc]] diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc index 8586962c835..e972cf040e2 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc @@ -29,8 +29,11 @@ experimental[] [[ml-get-inference-prereq]] ==== {api-prereq-title} -* You must have `monitor_ml` privilege to use this API. For more information, -see <> and <>. +Required privileges which should be added to a custom role: + +* cluster: `monitor_ml` + +For more information, see <> and <>. [[ml-get-inference-desc]] diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index bf48b5afae0..67ca7192d50 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -20,10 +20,17 @@ experimental[] [[ml-put-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `machine_learning_admin` built-in role to use this API. You must -also have `read` and `view_index_metadata` privileges on the source index and -`read`, `create_index`, and `index` privileges on the destination index. For -more information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: + +* `machine_learning_admin` +* `kibana_user` (UI only) + + +* source index: `read`, `view_index_metadata` +* destination index: `read`, `create_index`, `manage` and `index` +* cluster: `monitor` (UI only) + +For more information, see <> and <>. [[ml-put-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc index 6e1fd7ffe1a..f2b1586c31b 100644 --- a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc @@ -20,10 +20,18 @@ experimental[] [[ml-start-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `machine_learning_admin` built-in role to use this API. You must -also have `read` and `view_index_metadata` privileges on the source index and -`read`, `create_index`, and `index` privileges on the destination index. For -more information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: + +* `machine_learning_admin` +* `kibana_user` (UI only) + + +* source index: `read`, `view_index_metadata` +* destination index: `read`, `create_index`, `manage` and `index` +* cluster: `monitor` (UI only) + +For more information, see <> and <>. + [[ml-start-dfanalytics-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc index 7ea707b9d1b..741e4551ceb 100644 --- a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc @@ -24,8 +24,13 @@ experimental[] [[ml-stop-dfanalytics-prereq]] ==== {api-prereq-title} -* You must have `machine_learning_admin` built-in role to use this API. For more -information, see <> and <>. +If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: + +* `machine_learning_admin` +* `kibana_user` (UI only) + +For more information, see <> and <>. + [[ml-stop-dfanalytics-desc]] ==== {api-description-title}