Skip to content

Commit 93caa41

Browse files
[DOCS][ResponseOps][Reporting][8.19] Add documentation about required privileges with API key authentication (#234255)
Contributes to elastic/docs-content#2679 by adding a note about the new API authentication key method that was implemented for report generation in 8.19. The note also explains the specific cluster and index privileges that users with cross-cluster search environments must have. Previews: - [Automatically generate reports](https://kibana_bk_234255.docs-preview.app.elstc.co/guide/en/kibana/8.19/automating-report-generation.html) - [Configure reporting in Kibana](https://kibana_bk_234255.docs-preview.app.elstc.co/guide/en/kibana/8.19/secure-reporting.html) **Corresponding 9.x/Serverless doc updates:** elastic/docs-content#2885
1 parent 42d22fe commit 93caa41

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/setup/configuring-reporting.asciidoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,13 @@ to make sure your hosts support our latest build of Chromium. For the most relia
2020
installing {kib} using <<docker, Docker>>, or using <<set-up-on-cloud, Elastic Cloud>>.
2121
============
2222

23-
For security, you grant users access to the {report-features} and secure the reporting endpoints
24-
with TLS/SSL encryption. Additionally, you can install graphical packages into the operating system
25-
to enable the {kib} server to have screenshotting capabilities.
23+
For security, you grant users access to the {report-features} and secure the reporting endpoints with TLS/SSL encryption. Additionally, you can install graphical packages into the operating system to enable the {kib} server to have screenshotting capabilities.
24+
25+
[NOTE]
26+
============
27+
28+
In 8.19.0, API keys are used to authenticate requests to generate reports. If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the leader index, instead of the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
29+
============
2630

2731
* <<grant-user-access>>
2832
* <<reporting-roles-user-api>>

docs/user/reporting/automating-report-generation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {watcher} or a script. Alternatively, use {kib} to generate reports on a recurring schedule and share them with a list of emails that you specify.
66

7+
NOTE: In 8.19.0, API keys are used to authenticate requests to generate reports. If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the leader index, instead of the remote. For more information and examples, refer to {ref}/remote-clusters-cert.html#remote-clusters-privileges-cert[Configure roles and users for remote clusters].
8+
79
[float]
810
[[create-a-post-url]]
911
=== Create a POST URL

0 commit comments

Comments
 (0)