Die Reporting-API von KnowBe4 ist im Platinum- und Diamond-Abonnement enthalten. Mithilfe dieser API können Daten aus der KSAT-Konsole für das Reporting abgerufen werden. Momentan können mit dieser Funktion Anfragen nach Phishing-, Trainings-, Nutzer- und Gruppendaten gestellt werden. Um diese API verwenden zu können, müssen Sie sich mit einem kontospezifischen Schlüssel authentifizieren.
Ausführliche Informationen über die Reporting-API sowie Beispielanfragen finden Sie in unserer Entwicklerdokumentation zur Reporting-API. Die API von KnowBe4 ist eine REST-API. Durch die Nutzung der API von KnowBe4 stimmen Sie unseren Nutzungsbedingungen zu.
Erstellen eines Reporting-API-Tokens
Gehen Sie wie folgt vor, um ein Reporting-API-Token zu erstellen:
- Klicken Sie in Ihrer KSAT-Konsole oben rechts auf Ihre E-Mail-Adresse und wählen Sie Kontoeinstellungen aus.
- Navigieren Sie zu Kontointegrationen > API.
- Wählen Sie unter Reporting-API den Schalter Reporting-API-Zugriff aktivieren aus.
- Klicken Sie auf Reporting-API. Die Unterregisterkarte Reporting-API wird geöffnet.
- Klicken Sie oben rechts auf der Unterregisterkarte „Reporting-API“ auf + Neues API-Token erstellen.
- Füllen Sie die Felder auf der Seite Neues API-Token erstellen aus. Weitere Informationen finden Sie im Screenshot und in der folgenden Liste:
- Name: Geben Sie in diesem Feld einen aussagekräftigen Namen für dieses API-Token ein.
- Status: Aktivieren oder deaktivieren Sie das API-Token.
- Klicken Sie auf Token erstellen. Das Pop-up-Fenster Reporting-API-Token wird geöffnet.
- Klicken Sie auf das Reporting-API-Token, um es zu kopieren. Speichern Sie das kopierte API-Token an einem Ort, an dem Sie leicht darauf zugreifen können. Nachdem Sie dieses Fenster geschlossen haben, können Sie dieses Token nicht mehr anzeigen.
- Klicken Sie auf OK.
Nach dem Kopieren können Sie das API-Token verwenden, um Daten aus der KSAT-Konsole zu Reporting-Zwecken abzurufen.
Verwalten des Reporting-API-Tokens
Sobald Sie ein Reporting-API-Token erstellt haben, können Sie das Token auf der Unterregisterkarte „Reporting-API“ verwalten. Sie finden diese Unterregisterkarte im Abschnitt „Kontointegrationen“ auf der Seite mit den Kontoeinstellungen.
Weitere Informationen über die in diesem Abschnitt verfügbaren Optionen finden Sie im Folgenden:
- Schlüssel: In dieser Spalte wird eine eindeutige Kennung (ID) angezeigt, die zur Authentifizierung einer mit Ihrer KSAT-Konsole verknüpften API-Anfrage verwendet wird.
- Name: In dieser Spalte wird der benutzerdefinierte Name angezeigt, den Sie Ihrem API-Token bei seiner Erstellung zugewiesen haben.
- Generiert von: In dieser Spalte wird die E-Mail-Adresse der Nutzerin oder des Nutzers angezeigt, von der bzw. dem das API-Token generiert wurde.
- Generiert am: In dieser Spalte wird das Datum angezeigt, an dem das Reporting-API-Token generiert wurde.
- Status: Diese Spalte enthält den Status des API-Tokens. Der Status kann aktiviert oder deaktiviert sein.
-
Aktionen: Klicken Sie in der Spalte ganz rechts auf den Drop-down-Pfeil, um die verfügbaren Aktionen für ein Reporting-API-Token anzuzeigen. Aktionen:
- Bearbeiten: Klicken Sie auf Bearbeiten, um die Seite Reporting-API-Token bearbeiten zu öffnen. Diese Seite sieht so ähnlich aus wie die Seite Neues API-Token erstellen. Bearbeiten Sie die Optionen wie gewünscht und klicken Sie auf Token aktualisieren, um die Änderungen zu speichern.
- Löschen: Klicken Sie auf Löschen, um ein Reporting-API-Token dauerhaft zu löschen.