Skip to content

Commit

Permalink
Update api-keys.asciidoc - API key prerequisites (#21026) (#21028)
Browse files Browse the repository at this point in the history
* 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 <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Rob Waight <43173714+rwaight@users.noreply.github.com>
  • Loading branch information
dedemorton and rwaight authored Sep 10, 2020
1 parent 768dfc9 commit 100f8ec
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions libbeat/docs/security/api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<feature-roles>> before creating API keys for {beatname_uc}.

[float]
[[beats-api-key-publish]]
=== Create an API key for publishing
Expand Down Expand Up @@ -41,6 +43,8 @@ POST /_security/api_key
<1> Name of the API key
<2> Granted privileges, see <<feature-roles>>

NOTE: See <<privileges-to-publish-events>> for the list of privileges required to publish events.

The return value will look something like this:

[source,console-result,subs="attributes,callouts"]
Expand Down Expand Up @@ -89,6 +93,8 @@ POST /_security/api_key
<1> Name of the API key
<2> Granted privileges, see <<feature-roles>>

NOTE: See <<privileges-to-publish-monitoring>> for the list of privileges required to send monitoring data.

The return value will look something like this:

[source,console-result,subs="attributes,callouts"]
Expand Down

0 comments on commit 100f8ec

Please sign in to comment.