Skip to content

Commit a723215

Browse files
[7.16] [docs] Fix wrong example and highlight Kibana API (elastic#124347) (elastic#147869)
# Backport This will backport the following commits from `main` to `7.16`: - [[docs] Fix wrong example and highlight Kibana API (elastic#124347)](elastic#124347) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Toby Sutor","email":"[email protected]"},"sourceCommit":{"committedDate":"2022-12-20T15:42:15Z","message":"[docs] Fix wrong example and highlight Kibana API (elastic#124347)\n\nThe 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.\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"53e42eb6339aace91c5111bdb910dec8f9dacf5e","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","v8.0.0","release_note:skip","docs","v7.14.0","auto-backport","v7.15.0","v7.16.0","v8.1.0","v7.17.0","v8.2.0"],"number":124347,"url":"https://github.com/elastic/kibana/pull/124347","mergeCommit":{"message":"[docs] Fix wrong example and highlight Kibana API (elastic#124347)\n\nThe 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.\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"53e42eb6339aace91c5111bdb910dec8f9dacf5e"}},"sourceBranch":"main","suggestedTargetBranches":["8.0","7.14","7.15","7.16","8.1","7.17","8.2"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.14","label":"v7.14.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.15","label":"v7.15.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.16","label":"v7.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.17","label":"v7.17.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Toby Sutor <[email protected]>
1 parent 5dc9eba commit a723215

File tree

1 file changed

+19
-33
lines changed

1 file changed

+19
-33
lines changed

docs/setup/configuring-reporting.asciidoc

Lines changed: 19 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -112,41 +112,27 @@ Granting the privilege to generate reports also grants the user the privilege to
112112
==== Grant access with the role API
113113
With <<grant-user-access, {kib} application privileges>> 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.
114114

115-
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-user-access-basic>>.
116-
117-
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.
118-
119-
[source, json]
115+
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
116+
[source, sh]
120117
---------------------------------------------------------------
121-
PUT localhost:5601/api/security/role/custom_reporting_user
118+
POST <kibana host>:<port>/api/_security/role/custom_reporting_user
122119
{
123-
"elasticsearch": { "cluster": [], "indices": [], "run_as": [] },
124-
"kibana": [
125-
{
126-
"base": [],
127-
"feature": {
128-
"dashboard": [
129-
"minimal_read",
130-
"generate_report", <1>
131-
"download_csv_report" <2>
132-
],
133-
"discover": [
134-
"minimal_read",
135-
"generate_report" <3>
136-
],
137-
"canvas": [
138-
"minimal_read",
139-
"generate_report" <4>
140-
],
141-
"visualize": [
142-
"minimal_read",
143-
"generate_report" <5>
144-
]
145-
},
146-
"spaces": [ "*" ]
147-
}
148-
],
149-
"metadata": {} // optional
120+
"elasticsearch": {
121+
"cluster": [],
122+
"indices": [],
123+
"run_as": []
124+
},
125+
"kibana": [{
126+
"spaces": ["*"],
127+
"base": [],
128+
"feature": {
129+
"dashboard": ["generate_report", <1>
130+
"download_csv_report"], <2>
131+
"discover": ["generate_report"], <3>
132+
"canvas": ["generate_report"], <4>
133+
"visualize": ["generate_report"] <5>
134+
}
135+
}]
150136
}
151137
---------------------------------------------------------------
152138
// CONSOLE

0 commit comments

Comments
 (0)