]> granicus.if.org Git - icinga2/commitdiff
clarify the permision system of the api in the docs 6350/head
authorLeah Oswald <mail@leahoswald.de>
Tue, 5 Jun 2018 14:20:09 +0000 (16:20 +0200)
committerLeah Oswald <mail@leahoswald.de>
Tue, 5 Jun 2018 14:20:09 +0000 (16:20 +0200)
Clarify that the permission system used by the api isn't equivalent
with the system used by the Icinga Web 2 frontend. And that its rather based
on the url scheme of the API endpoints.

doc/12-icinga2-api.md

index c05522999fd3aa6c0387a3a816aaa86b34a9eaa8..d427505ad575667c9bf7e12116887608370ee710 100644 (file)
@@ -196,13 +196,15 @@ actions on the URL endpoints.
 
 Permissions for API users must be specified in the `permissions` attribute
 as array. The array items can be a list of permission strings with wildcard
-matches.
+matches. Please notice, that the permission system that is used by the API differs from the permission system used by the Icinga Web 2 frontend or other parts of Icinga 2.
+
+The permission system mainly relies on the url scheme of the API endpoints (See listing below).
 
 Example for an API user with all permissions:
 
     permissions = [ "*" ]
 
-Note that you can use wildcards. Here's another example that only allows the user
+Note that you can use wildcards to include all possible hierarchically lower items. Here's another example that only allows the user
 to perform read-only object queries for hosts and services:
 
     permissions = [ "objects/query/Host", "objects/query/Service" ]