Wie konfiguriere ich die Berechtigungen für eine Zendesk App richtig?

1. Verwendung der manifest.json zur Festlegung der Berechtigungen
2. Die wichtigsten Permission-Typen und deren Nutzung
3. Best Practices bei der Berechtigungsvergabe
4. Hinzufügen von Berechtigungen im manifest.json-Beispiel
5. Weitere Hinweise zur Sicherheit und zur Dokumentation

Die korrekte Konfiguration der Berechtigungen ist ein essenzieller Schritt bei der Entwicklung einer Zendesk App, damit diese sicher und funktional im Zendesk-Ökosystem arbeiten kann. Berechtigungen in Zendesk Apps definieren, auf welche Daten und Ressourcen die App zugreifen darf sowie welche Aktionen sie durchführen kann. Dies wird zentral über die Manifest-Datei namens manifest.json gesteuert, die alle wichtigen Metadaten und die Zugriffsrechte beinhaltet.

Verwendung der manifest.json zur Festlegung der Berechtigungen

Die Manifest-Datei ist das Herzstück jeder Zendesk App-Konfiguration. In dieser JSON-Datei werden grundlegende Informationen wie Name, Version und Beschreibung der App ebenso hinterlegt wie die gewünschten Berechtigungen unter dem Schlüssel permissions. Hier definieren Sie, welches Zendesk-Feature die App benötigt, z. B. Zugriff auf Tickets, Nutzer, Organisationen oder andere API-Funktionen. Die Angabe der Berechtigungen ist entscheidend, da Zendesk beim Installations- oder Aktualisierungsvorgang prüft, welche Ressourcen Ihre App nutzen möchte, und diese Einschränkungen im App-Kontext durchsetzt.

Die wichtigsten Permission-Typen und deren Nutzung

Zu den häufig verwendeten Berechtigungen zählen etwa read und write für verschiedene Arten von Ressourcen. So können Sie beispielsweise mit "tickets:read" nur Leserechte auf Tickets anfordern, während "tickets:write" auch Änderungen erlaubt. Für Nutzerinformationen wären das vergleichbar "users:read" oder "users:write". Zudem können Sie Berechtigungen für weitere Bereiche wie organizations, groups oder settings setzen. Je restriktiver Sie diese Rechte vergeben, desto sicherer ist Ihre App gegenüber unerlaubtem Zugriff, gleichzeitig sollte die App aber alle nötigen Rechte erhalten, um ihre Funktionalität voll auszuführen.

Best Practices bei der Berechtigungsvergabe

Es empfiehlt sich, immer das Prinzip der minimalen Rechtevergabe zu befolgen. Das bedeutet, nur jene Berechtigungen zu beantragen, die tatsächlich für die Funktionsweise Ihrer App erforderlich sind. So schützen Sie sowohl die Daten der Nutzer als auch die Integrität der Zendesk-Instanz. Außerdem erleichtert dies spätere Sicherheitsprüfungen und sorgt für eine höhere Akzeptanz Ihrer App bei Administratoren. Testen Sie Ihre App in einer Entwicklungsumgebung mit den festgelegten Berechtigungen, um sicherzustellen, dass keine unerwarteten Fehler durch fehlende Rechte auftreten.

Hinzufügen von Berechtigungen im manifest.json-Beispiel

Ein typisches Beispiel, wie der Permissions-Abschnitt in der manifest.json aussieht, könnte folgendermaßen sein:

Hierin werden die Berechtigungen für das Lesen und Schreiben von Tickets sowie das Lesen von Nutzerinformationen angegeben. Passen Sie diese Liste entsprechend der Anforderungen Ihrer App an.

Weitere Hinweise zur Sicherheit und zur Dokumentation

Neben der reinen Berechtigungskonfiguration sollten Sie auch in Ihrer App Dokumentation und Benutzerführung deutlich machen, welche Rechte die App benötigt und warum. So schaffen Sie Transparenz für Administratoren, die Ihre App installieren oder genehmigen. Achten Sie außerdem darauf, dass sensible Daten nur dann abgerufen oder verändert werden, wenn es unbedingt notwendig ist, und schützen Sie die Kommunikation Ihrer App mit Zendesk-APIs über HTTPS und sichere Authentifizierungsmechanismen wie OAuth oder API-Tokens.

Insgesamt ist die richtige Einstellung und Pflege der Permissions für eine Zendesk App entscheidend für ihre erfolgreiche Integration, Sicherheit und Nutzerakzeptanz.