API-Zugänge verwalten Praxis Desk
In der Übersicht siehst du alle erstellten API-Zugänge. Du kannst ihre Berechtigungen nachträglich ändern und sie bei Bedarf widerrufen.
Wo finde ich API-Zugänge?
Öffne Einstellungen > OAuth / API. Die Liste zeigt alle erstellten Zugänge.
Voraussetzungen
- Du verfügst über die Berechtigung OAuth API-Clients verwalten in deinem Offisy-Konto.
- Du bist Mitarbeiter:in der Firma. Als Kooperationsbenutzer:in kannst du keine API-Zugänge einer anderen Firma verwalten.
Datentabelle
Die Liste zeigt zu jedem Zugang folgende Informationen:
| Information | Beschreibung |
|---|---|
| Name | Der vergebene Name des Zugangs. |
| Erstellt von | Welcher Benutzer den Zugang erstellt hat. |
| Erstellt am | Datum der Erstellung. |
| Aktive Scopes | Welche Berechtigungen der Zugang hat. |
| Berechtigungen geändert | Datum und Benutzer der letzten Änderung. Erscheint nur, wenn die Berechtigungen schon einmal geändert wurden. |
Die Liste zeigt nur die jeweils letzte Änderung, keine vollständige Historie.
Berechtigungen ändern
Du kannst die Berechtigungen eines bestehenden Zugangs jederzeit anpassen, ohne den Zugang zu widerrufen.
- Öffne im Aktionsmenü des Zugangs den Eintrag Berechtigungen bearbeiten.
- Wähle Vollzugriff oder Individuell.
- Setze bei Individuell die gewünschten Berechtigungen. Mehr dazu: Scopes verstehen.
- Klicke auf Speichern.
Entziehst du Berechtigungen, zeigt der Dialog vor dem Speichern eine Warnung mit den betroffenen Berechtigungen.
Speichern ist deaktiviert, solange du nichts geändert hast oder keine einzige Berechtigung ausgewählt ist.
Name und Beschreibung eines Zugangs kannst du nicht ändern, nur die Berechtigungen.
Hinweis: Die Änderung wirkt sofort und in beide Richtungen. Bestehende Tokens erhalten neue Berechtigungen ohne Erneuerung, ein Entzug greift ebenso sofort und kann eine laufende Integration unmittelbar unterbrechen. Client-ID und Client-Secret bleiben unverändert.
API-Zugang widerrufen
- Wähle den Zugang aus, den du widerrufen möchtest.
- Klicke auf Widerrufen.
- Bestätige den Vorgang im Bestätigungs-Dialog.
Alle Tokens dieses Zugangs sind danach sofort ungültig. Externe Anwendungen, die diesen Zugang verwenden, verlieren sofort den Zugriff.
Hinweis: Ein widerrufener Zugang kann nicht wiederhergestellt werden. Du musst einen neuen Zugang erstellen. Willst du nur die Berechtigungen korrigieren, nutze stattdessen Berechtigungen bearbeiten. Client-ID und Client-Secret bleiben dabei erhalten.
Hinweis: Ein API-Zugang funktioniert nur, solange sein Besitzer aktiv ist. Wird der Besitzer gelöscht, widerruft Offisy seine API-Zugänge automatisch.