Eine Berechtigung anlegen

5 Schritte·ca. 15 Min.·Einsteiger·Stand: September 2026

Sie schützen den Status-Endpunkt aus „Einen API-Endpunkt anlegen“ mit einer Berechtigung Ihres Bundles. Administratoren vergeben sie in der Rechteverwaltung von Vendority.

Was Sie bauen

Die Berechtigung acme:view: Der Endpunkt prüft sie mit #[IsGranted], die Komponente mit isAllowed(), und Administratoren schalten sie unter „Einstellungen“ → „Gruppen“ frei.

Voraussetzungen

  • Zuerst durcharbeiten: Ein Bundle anlegen
  • Zuerst durcharbeiten: Einen API-Endpunkt anlegen
  • Das Bundle acme mit dem Endpunkt GET /api/bundle/acme/status und der Komponente AcmeStatusCard aus „Einen API-Endpunkt anlegen“
  • Ein Testbenutzer ohne Administratorrechte, der Mitglied einer Gruppe ist
Schritt 1 von 5

Schritt 1 von 5

Die Berechtigung deklarieren

Eine Berechtigung ist eine kleine Klasse mit einer eindeutigen Kennung.

src/Permission/ViewPermission.php Neue Datei
<?php
declare(strict_types=1);

namespace Vendority\Bundle\Acme\Permission;

use Vendority\Bundle\Core\Security\Permission\AccessPermissionInterface;

final class ViewPermission implements AccessPermissionInterface
{
    public const string IDENTIFIER = 'acme:view';

    public function getName(): string
    {
        return 'Acme-Status sehen';
    }

    public function getIdentifier(): string
    {
        return self::IDENTIFIER;
    }

    public function getGroup(): string
    {
        return 'Acme';
    }
}
  1. 1

    AccessPermissionInterface steht für einen Schalter: Jemand hat die Berechtigung, oder er hat sie nicht.

  2. 2

    Die Kennung acme:view steht in der Konstante IDENTIFIER. Server und Frontend prüfen später genau diesen Text. Beginnen Sie die Kennung mit dem Namen Ihres Bundles.

  3. 3

    getName() ist die Beschriftung des Schalters in der Rechteverwaltung, getGroup() die Zeile darunter.

  4. 4

    Beide Texte zeigt Vendority in jeder Sprache so an, wie sie im Code stehen. Schreiben Sie sie in der Sprache Ihrer Benutzer.

Schritt 2 von 5

Die Berechtigung registrieren

Wie ein Controller wird auch eine Berechtigung erst als Service wirksam.

config/services.yaml Geändert
services:
    _defaults:
        autowire: true
        autoconfigure: true
…
    Vendority\Bundle\Acme\Permission\ViewPermission: ~

+1 Zeile neu · grau: bestehender Code zur Orientierung

  1. 1

    Mit autoconfigure bekommt jeder Service, der PermissionInterface umsetzt, das Tag vendority.permission. Darüber sammelt der Core alle Berechtigungen ein.

  2. 2

    Die Schnittstelle allein reicht nicht. Ohne Eintrag in services.yaml bleibt die Klasse unbekannt.

  3. 3

    Bei mehreren Berechtigungen tragen Sie statt der Klasse den Ordner ein: Vendority\Bundle\Acme\Permission\: mit resource: '../src/Permission'.

Schritt 3 von 5

Den Endpunkt absichern

Im Status-Controller ersetzen Sie die allgemeine Anmeldeprüfung durch Ihre Berechtigung.

src/Status/Controller/StatusController.php Geändert
use Vendority\Bundle\Acme\Permission\ViewPermission;
use Vendority\Bundle\Acme\Status\Schema\AcmeStatus;
…
    #[Route(self::ROUTE, name: 'vendority_acme_status_get', methods: ['GET'])]
    #[IsGranted(ViewPermission::IDENTIFIER)]
    #[Get(
…
    #[DefaultResponses([HttpResponseCodes::UNAUTHORIZED, HttpResponseCodes::FORBIDDEN])]
    public function __invoke(): JsonResponse

+3 Zeilen neu · grau: bestehender Code zur Orientierung

  1. 1

    #[IsGranted(ViewPermission::IDENTIFIER)] ersetzt #[IsGranted('ROLE_USER')]. Wer die Berechtigung nicht hat, bekommt 403, bevor __invoke() läuft.

  2. 2

    Die neue Zeile mit DefaultResponses ersetzt die alte und nimmt 403 in die API-Referenz auf.

  3. 3

    Administratoren bestehen jede Prüfung. Testen Sie deshalb mit Ihrem Testbenutzer.

  4. 4

    Soll eine von mehreren Berechtigungen genügen, verwenden Sie #[IsGrantedAny([…])] aus Vendority\Bundle\Core\Attribute.

  5. 5

    In einem Service prüfen Sie dieselbe Kennung mit AuthorizationCheckerInterface::isGranted(ViewPermission::IDENTIFIER).

Schritt 4 von 5

In der Oberfläche prüfen

Die Komponente soll nur erscheinen, wenn der Benutzer die Berechtigung hat. Ohne Berechtigung stellt sie auch keine Anfrage.

assets/js/src/modules/status/components/acme-status-card.tsx Geändert
import { isAllowed } from '@vendority/core/permissions'
import { useAcmeStatusGetQuery } from '@vendority/acme/api/acme-api-slice.gen'
…
export const AcmeStatusCard = (): React.JSX.Element | null => {
  const allowed = isAllowed('acme:view')
  const { data, isLoading } = useAcmeStatusGetQuery(undefined, { skip: !allowed })
  if (!allowed || isLoading || data === undefined) {
    return null
  }
…

+4 Zeilen neu · grau: bestehender Code zur Orientierung

  1. 1

    Importieren Sie isAllowed aus @vendority/core/permissions. Nur über diesen Pfad bekommt das Bundle die Funktion der laufenden App, und nur sie kennt den angemeldeten Benutzer.

  2. 2

    Eine eigene Kopie der Funktion im Bundle kennt keinen Benutzer. Sie antwortet immer mit false und meldet dabei keinen Fehler.

  3. 3

    Die beiden Zeilen mit dem Hook und der Bedingung ersetzen die entsprechenden Zeilen aus dem ersten Tutorial.

  4. 4

    skip: !allowed unterdrückt die Anfrage, solange die Berechtigung fehlt. So landet kein 403 in der Konsole.

  5. 5

    Für Administratoren gibt isAllowed() immer true zurück, genau wie die Prüfung am Server.

Schritt 5 von 5

Die Berechtigung freischalten

Administratoren vergeben Ihre Berechtigung in der Rechteverwaltung von Vendority. Dafür müssen Sie nichts programmieren.

  1. 1

    Melden Sie sich als Administrator an, öffnen Sie „Einstellungen“ und dort den Reiter „Gruppen“.

  2. 2

    Öffnen Sie die Gruppe, in der Ihr Testbenutzer Mitglied ist.

  3. 3

    Klappen Sie „Weitere Berechtigungen“ auf. Unter „Sonstiges“ steht der Schalter „Acme-Status sehen“, darunter „Acme“.

  4. 4

    Schalten Sie ihn ein und klicken Sie auf „Änderungen speichern“.

  5. 5

    Einer einzelnen Person geben Sie die Berechtigung unter „Einstellungen“ → „Benutzer“ auf ihrer Seite, ebenfalls unter „Weitere Berechtigungen“.

Geschafft.

Sie haben „Eine Berechtigung anlegen“ von Anfang bis Ende durchgearbeitet.

Zurück zu „Daten & API“

Blättern auch mit ← und →