[DOCS] Forms role and privilege requirements as bulleted lists in DFA API docs (#50732)
Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
parent
8a1bb440e2
commit
0ac6786f41
|
@ -21,8 +21,12 @@ experimental[]
|
||||||
[[ml-delete-dfanalytics-prereq]]
|
[[ml-delete-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `machine_learning_admin` built-in role to use this API. For more
|
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
||||||
information, see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* `machine_learning_admin`
|
||||||
|
* `kibana_user` (UI only)
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-delete-dfanalytics-path-params]]
|
[[ml-delete-dfanalytics-path-params]]
|
||||||
|
|
|
@ -22,8 +22,12 @@ experimental[]
|
||||||
[[ml-delete-inference-prereq]]
|
[[ml-delete-inference-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `machine_learning_admin` built-in role to use this API. For more
|
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
||||||
information, see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* `machine_learning_admin`
|
||||||
|
* `kibana_user` (UI only)
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-delete-inference-path-params]]
|
[[ml-delete-inference-path-params]]
|
||||||
|
@ -64,4 +68,3 @@ The API returns the following result:
|
||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -22,8 +22,11 @@ experimental[]
|
||||||
[[ml-evaluate-dfanalytics-prereq]]
|
[[ml-evaluate-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `monitor_ml` privilege to use this API. For more
|
If the {es} {security-features} are enabled, you must have the following privileges:
|
||||||
information, see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* cluster: `monitor_ml`
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-evaluate-dfanalytics-desc]]
|
[[ml-evaluate-dfanalytics-desc]]
|
||||||
|
|
|
@ -28,8 +28,11 @@ experimental[]
|
||||||
[[ml-explain-dfanalytics-prereq]]
|
[[ml-explain-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `monitor_ml` privilege to use this API. For more
|
If the {es} {security-features} are enabled, you must have the following privileges:
|
||||||
information, see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* cluster: `monitor_ml`
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-explain-dfanalytics-desc]]
|
[[ml-explain-dfanalytics-desc]]
|
||||||
|
|
|
@ -28,8 +28,11 @@ experimental[]
|
||||||
[[ml-get-dfanalytics-stats-prereq]]
|
[[ml-get-dfanalytics-stats-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `monitor_ml` privilege to use this API. For more
|
If the {es} {security-features} are enabled, you must have the following privileges:
|
||||||
information, see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* cluster: `monitor_ml`
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-get-dfanalytics-stats-path-params]]
|
[[ml-get-dfanalytics-stats-path-params]]
|
||||||
|
|
|
@ -27,8 +27,11 @@ experimental[]
|
||||||
[[ml-get-dfanalytics-prereq]]
|
[[ml-get-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `monitor_ml` privilege to use this API. For more information,
|
If the {es} {security-features} are enabled, you must have the following privileges:
|
||||||
see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* cluster: `monitor_ml`
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-get-dfanalytics-desc]]
|
[[ml-get-dfanalytics-desc]]
|
||||||
|
|
|
@ -29,8 +29,11 @@ experimental[]
|
||||||
[[ml-get-inference-stats-prereq]]
|
[[ml-get-inference-stats-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `monitor_ml` privilege to use this API. For more information,
|
Required privileges which should be added to a custom role:
|
||||||
see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* cluster: `monitor_ml`
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-get-inference-stats-desc]]
|
[[ml-get-inference-stats-desc]]
|
||||||
|
|
|
@ -29,8 +29,11 @@ experimental[]
|
||||||
[[ml-get-inference-prereq]]
|
[[ml-get-inference-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `monitor_ml` privilege to use this API. For more information,
|
Required privileges which should be added to a custom role:
|
||||||
see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* cluster: `monitor_ml`
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-get-inference-desc]]
|
[[ml-get-inference-desc]]
|
||||||
|
|
|
@ -20,10 +20,17 @@ experimental[]
|
||||||
[[ml-put-dfanalytics-prereq]]
|
[[ml-put-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `machine_learning_admin` built-in role to use this API. You must
|
If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
|
||||||
also have `read` and `view_index_metadata` privileges on the source index and
|
|
||||||
`read`, `create_index`, and `index` privileges on the destination index. For
|
* `machine_learning_admin`
|
||||||
more information, see <<security-privileges>> and <<built-in-roles>>.
|
* `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 <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-put-dfanalytics-desc]]
|
[[ml-put-dfanalytics-desc]]
|
||||||
|
|
|
@ -20,10 +20,18 @@ experimental[]
|
||||||
[[ml-start-dfanalytics-prereq]]
|
[[ml-start-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `machine_learning_admin` built-in role to use this API. You must
|
If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
|
||||||
also have `read` and `view_index_metadata` privileges on the source index and
|
|
||||||
`read`, `create_index`, and `index` privileges on the destination index. For
|
* `machine_learning_admin`
|
||||||
more information, see <<security-privileges>> and <<built-in-roles>>.
|
* `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 <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-start-dfanalytics-path-params]]
|
[[ml-start-dfanalytics-path-params]]
|
||||||
==== {api-path-parms-title}
|
==== {api-path-parms-title}
|
||||||
|
|
|
@ -24,8 +24,13 @@ experimental[]
|
||||||
[[ml-stop-dfanalytics-prereq]]
|
[[ml-stop-dfanalytics-prereq]]
|
||||||
==== {api-prereq-title}
|
==== {api-prereq-title}
|
||||||
|
|
||||||
* You must have `machine_learning_admin` built-in role to use this API. For more
|
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
||||||
information, see <<security-privileges>> and <<built-in-roles>>.
|
|
||||||
|
* `machine_learning_admin`
|
||||||
|
* `kibana_user` (UI only)
|
||||||
|
|
||||||
|
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||||
|
|
||||||
|
|
||||||
[[ml-stop-dfanalytics-desc]]
|
[[ml-stop-dfanalytics-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
Loading…
Reference in New Issue