From 53e42eb6339aace91c5111bdb910dec8f9dacf5e Mon Sep 17 00:00:00 2001 From: Toby Sutor <55087308+toby-sutor@users.noreply.github.com> Date: Tue, 20 Dec 2022 16:42:15 +0100 Subject: [PATCH] [docs] Fix wrong example and highlight Kibana API (#124347) The current example contains invalid characters and does not work. Furthermore does it incorrectly point towards the Elasticsearch API instead of the Kibana API. Both is addressed in this change. Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- docs/setup/configuring-reporting.asciidoc | 52 +++++++++-------------- 1 file changed, 19 insertions(+), 33 deletions(-) diff --git a/docs/setup/configuring-reporting.asciidoc b/docs/setup/configuring-reporting.asciidoc index d6daa34d5bf287..3cb20866d77535 100644 --- a/docs/setup/configuring-reporting.asciidoc +++ b/docs/setup/configuring-reporting.asciidoc @@ -111,41 +111,27 @@ Granting the privilege to generate reports also grants the user the privilege to ==== Grant access with the role API With <> enabled in Reporting, you can also use the {ref}/security-api-put-role.html[role API] to grant access to the {report-features}, using *All* privileges, or sub-feature privileges. -NOTE: If you have a Basic license, sub-feature privileges are unavailable. For details, check out the API command to grant *All* privileges in <>. - -Grant users custom Reporting roles, other roles that grant read access to the data in {es}, and at least read access in the applications where users can generate reports. - -[source, json] +NOTE: this [API request](https://www.elastic.co/guide/en/kibana/current/role-management-api-put.html) needs to be executed against the Kibana API endpoint +[source, sh] --------------------------------------------------------------- -PUT localhost:5601/api/security/role/custom_reporting_user +POST :/api/_security/role/custom_reporting_user { - "elasticsearch": { "cluster": [], "indices": [], "run_as": [] }, - "kibana": [ - { - "base": [], - "feature": { - "dashboard": [ - "minimal_read", - "generate_report", <1> - "download_csv_report" <2> - ], - "discover": [ - "minimal_read", - "generate_report" <3> - ], - "canvas": [ - "minimal_read", - "generate_report" <4> - ], - "visualize": [ - "minimal_read", - "generate_report" <5> - ] - }, - "spaces": [ "*" ] - } - ], - "metadata": {} // optional + "elasticsearch": { + "cluster": [], + "indices": [], + "run_as": [] + }, + "kibana": [{ + "spaces": ["*"], + "base": [], + "feature": { + "dashboard": ["generate_report", <1> + "download_csv_report"], <2> + "discover": ["generate_report"], <3> + "canvas": ["generate_report"], <4> + "visualize": ["generate_report"] <5> + } + }] } --------------------------------------------------------------- // CONSOLE