Pārlūkot izejas kodu

[DOCS] Adds more authorization info for CCR APIs (#35606)

Lisa Cawley 6 gadi atpakaļ
vecāks
revīzija
78209188bc

+ 6 - 0
docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc

@@ -48,6 +48,12 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
 `auto_follow_pattern_name` (required)::
   (string) specifies the auto-follow pattern collection to delete
 
+==== Authorization
+
+If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
+privileges on the cluster that contains the follower index. For more information,
+see {stack-ov}/security-privileges.html[Security privileges].
+
 ==== Example
 
 This example deletes an auto-follow pattern collection named

+ 6 - 0
docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc

@@ -64,6 +64,12 @@ GET /_ccr/auto_follow/<auto_follow_pattern_name>
   retrieve; if you do not specify a name, the API returns information for all
   collections
 
+==== Authorization
+
+If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
+privileges on the cluster that contains the follower index. For more information,
+see {stack-ov}/security-privileges.html[Security privileges].
+
 ==== Example
 
 This example retrieves information about an auto-follow pattern collection

+ 8 - 0
docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc

@@ -70,6 +70,14 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name
 
 include::../follow-request-body.asciidoc[]
 
+==== Authorization
+
+If the {es} {security-features} are enabled, you must have `read` and `monitor`
+index privileges for the leader index patterns. You must also have `manage_ccr`
+cluster privileges on the cluster that contains the follower index. For more
+information, see
+{stack-ov}/security-privileges.html[Security privileges].
+
 ==== Example
 
 This example creates an auto-follow pattern named `my_auto_follow_pattern`:

+ 6 - 0
docs/reference/ccr/apis/follow/get-follow-stats.asciidoc

@@ -179,6 +179,12 @@ Continuing with the fields from `shards`:
   task; in this situation, the following task must be resumed manually with the
   <<ccr-post-resume-follow,resume follower API>>
 
+==== Authorization
+
+If the {es} {security-features} are enabled, you must have `monitor` cluster
+privileges on the cluster that contains the follower index. For more information,
+see {stack-ov}/security-privileges.html[Security privileges].
+
 ==== Example
 
 This example retrieves follower stats:

+ 6 - 0
docs/reference/ccr/apis/follow/post-unfollow.asciidoc

@@ -54,6 +54,12 @@ POST /<follower_index>/_ccr/unfollow
 
 `follower_index` (required)::
   (string) the name of the follower index
+  
+==== Authorization
+
+If the {es} {security-features} are enabled, you must have `manage_follow_index` 
+index privileges for the follower index. For more information, see
+{stack-ov}/security-privileges.html[Security privileges].  
 
 ==== Example
 

+ 6 - 0
docs/reference/ccr/apis/get-ccr-stats.asciidoc

@@ -80,6 +80,12 @@ This object consists of the following fields:
   to the details of the response in the
   <<ccr-get-follow-stats,get follower stats API>>
 
+==== Authorization
+
+If the {es} {security-features} are enabled, you must have `monitor` cluster
+privileges on the cluster that contains the follower index. For more information,
+see {stack-ov}/security-privileges.html[Security privileges].
+
 ==== Example
 
 This example retrieves {ccr} stats: