Skip to content

Commit

Permalink
[DOCS] Adds authorization info for CCR APIs (#35557)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Nov 21, 2018
1 parent a21169f commit 87cb628
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/reference/ccr/apis/follow/post-pause-follow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ POST /<follower_index>/_ccr/pause_follow
`follower_index` (required)::
(string) the name of the follower index


==== 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 pauses a follower index named `follower_index`:
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/ccr/apis/follow/post-resume-follow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ POST /<follower_index>/_ccr/resume_follow
==== Request Body
include::../follow-request-body.asciidoc[]

==== Authorization

If the {es} {security-features} are enabled, you must have `write` and `monitor`
index privileges for the follower index. You must have `read` and `monitor`
index privileges for the leader index. 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 resumes a follower index named `follower_index`:
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/ccr/apis/follow/put-follow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,15 @@ PUT /<follower_index>/_ccr/follow

include::../follow-request-body.asciidoc[]

==== Authorization

If the {es} {security-features} are enabled, you must have `write`, `monitor`,
and `manage_follow_index` index privileges for the follower index. You must have
`read` and `monitor` index privileges for the leader index. 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 a follower index named `follower_index`:
Expand Down

0 comments on commit 87cb628

Please sign in to comment.