From 1337c658f58c49e2d69e99823ca2d9d1772e6722 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Wed, 9 Sep 2020 23:25:30 -0700 Subject: [PATCH] Update api-keys.asciidoc - API key prerequisites (#21026) (#21029) * Update api-keys.asciidoc - API key prerequisites Add references to required privileges within the API key examples * Update libbeat/docs/security/api-keys.asciidoc Co-authored-by: DeDe Morton Co-authored-by: DeDe Morton Co-authored-by: Rob Waight <43173714+rwaight@users.noreply.github.com> --- libbeat/docs/security/api-keys.asciidoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libbeat/docs/security/api-keys.asciidoc b/libbeat/docs/security/api-keys.asciidoc index 403fd011122..aa397ff5fee 100644 --- a/libbeat/docs/security/api-keys.asciidoc +++ b/libbeat/docs/security/api-keys.asciidoc @@ -14,6 +14,8 @@ API key. For different clusters, you need to use an API key per cluster. NOTE: For security reasons, we recommend using a unique API key per {beatname_uc} instance. You can create as many API keys per user as necessary. +IMPORTANT: Review <> before creating API keys for {beatname_uc}. + [float] [[beats-api-key-publish]] === Create an API key for publishing @@ -41,6 +43,8 @@ POST /_security/api_key <1> Name of the API key <2> Granted privileges, see <> +NOTE: See <> for the list of privileges required to publish events. + The return value will look something like this: [source,console-result,subs="attributes,callouts"] @@ -89,6 +93,8 @@ POST /_security/api_key <1> Name of the API key <2> Granted privileges, see <> +NOTE: See <> for the list of privileges required to send monitoring data. + The return value will look something like this: [source,console-result,subs="attributes,callouts"]