REST-API¶

Administratoren erstellen Bearer-Token mit festgelegten Scopes für externe Anwendungen.

Überblick¶

Diese Seite beschreibt die Bedienung und die wichtigsten Auswirkungen von REST-API. Änderungen sollten zunächst in einer Testumgebung geprüft werden, wenn sie bestehende Tickets, Berechtigungen, Benachrichtigungen oder Automatisierungen beeinflussen.

Typischer Arbeitsablauf¶

Benutzer für ein Token suchen. Nutzen Sie die vorhandenen Such-, Filter- und Detailansichten. Leeren oder ändern Sie Filter, wenn erwartete Datensätze nicht erscheinen.
Token mit Bezeichnung und Scopes erstellen. Öffnen Sie die entsprechende Verwaltungs- oder Aktionsmaske, tragen Sie die erforderlichen Werte ein und speichern Sie erst, nachdem Zuordnungen und Pflichtfelder geprüft wurden.
Tokenwert sicher übernehmen. Führen Sie die Funktion in der vorgesehenen Maske aus und prüfen Sie das Ergebnis unmittelbar in der zugehörigen Übersicht oder am betroffenen Ticket.
Token deaktivieren. Prüfen Sie zuvor, welche bestehenden Datensätze oder Benutzer davon betroffen sind. Verwenden Sie nach Möglichkeit die Deaktivierung statt einer endgültigen Entfernung.
Request-Logging und Idempotenz einordnen. Führen Sie die Funktion in der vorgesehenen Maske aus und prüfen Sie das Ergebnis unmittelbar in der zugehörigen Übersicht oder am betroffenen Ticket.
OpenAPI-Beschreibung aufrufen. Führen Sie die Funktion in der vorgesehenen Maske aus und prüfen Sie das Ergebnis unmittelbar in der zugehörigen Übersicht oder am betroffenen Ticket.

Hinweise¶

Sichtbare Menüpunkte und Aktionen hängen von den Gruppen- und Programmberechtigungen des angemeldeten Agenten ab.
Deaktivierte Einträge bleiben häufig für bestehende Tickets und Auswertungen erhalten, stehen aber nicht mehr für neue Zuordnungen zur Verfügung.
Prüfen Sie nach Änderungen mindestens einen realistischen Anwendungsfall mit einem Benutzer der betroffenen Rolle.