Berechtigungen¶
Die Routen der API sind auf Gruppenebene eingeschränkt.
Übersicht der Gruppen¶
| Gruppe | Beschreibung |
|---|---|
| administrator | Diese Gruppe ist in allen Routen der API definiert und sollte nur zur Administration verwendet werden. |
| manager | Mitglieder der Gruppe manager dürfen die meisten Routen aufrufen. |
| report-consumer | Mitglieder der Gruppe report-consumer dürfen alle allgemeinen API abrufen |
| dashboard-consumer | Mitglieder der Gruppe dashboard-consumer haben Zugriff auf Reports die im Standard-Dashboard angezeigt werden |
Folgende Gruppen kommen bei mehreren API zum Einsatz, besitzen aber immer einen Prefix. So setzt sich die Gruppe zum lesen der Projektdokumentation
aus dem Prefix documentation- und dem Namen file-consumer zusammen und heißt documentation-file-consumer;
erforderliche Gruppe documentation-file-consumer
| Gruppe | Beschreibung |
|---|---|
| data-manager | Mitglieder der Gruppe dürfen sowohl lesend als auch schreibend auf die API zugreifen. |
| data-consumer | Mitglieder der Gruppe dürfen die meisten API lesend benutzen |
| data-maintenance | Mitglieder der Gruppe dürfen zur Stammdatenpflege Datensätze anlegen, verwalten löschen. |
| file-manager | Mitglieder dieser Gruppe dürfen Dateien über die API hochladen, löschen und lesen. Außerdem erhalten Sie eine Dateiliste. |
| file-consumer | Mitglieder dieser Gruppe dürfen Dateien über die API lesen. |
Sondergruppen für Berechtigungen im Legacy-System
| Gruppe | Beschreibung |
|---|---|
| legacy-data-manager | Schreibender Zugriff auf Legacy-Funktionen |
| legacy-data-consumer | Lesender Zugriff auf Legacy-Funktionen |
Folgende Prefixe gibt es:
- client-
- documentation-
- item-
- company-
- country-
Kundenspezifische Anpassungen¶
Für die einzelnen Standard-Routen lassen sich kundenspezifische Anpassungen durchführen. Hierzu können weitere Gruppen über die folgenden Platzhalter in die bestehenden Routendefinitionen eingefügt werden.
- %{group-additionals-collection}
- %{group-additionals-search}
- %{group-additionals-object}
- %{group-additionals-update}
- %{group-additionals-multi-update}
- %{group-additionals-multi-patch}
- %{group-additionals-add}
- %{group-additionals-delete}
- %{group-additionals-multi-delete}
- %{group-additionals-upload}
- %{group-additionals-files}
- %{group-additionals-delete-file}
- %{group-additionals-property-collection}
- %{group-additionals-property-multi-update}
- %{group-additionals-property-multi-delete}
- %{group-additionals-property-add}
Für diese Platzhalter kann in einer Eigenschaftsdatei ein oder mehrere Entities definiert werden.
group-additionals-collection=<entity class="\Alvine\Application\Platform\Security\Authentication\Group">mygroup</entity> \
<entity class="\Alvine\Security\Authentication\User">[email protected]</entity>