API-Konfiguration: Aktivieren Sie die XML API und konfigurieren Sie benutzerdefinierte Felder

Verwaltung > API-Konfiguration

API :: Konfiguration

XML-API aktivieren

Sie können die BeyondTrust XML-API aktivieren, sodass Sie Berichte ausführen und Befehle ausgeben können, wie z. B. Start oder Übertragung von externen Anwendungen aus, sowie die automatische Sicherung Ihrer Softwarekonfiguration.

Nur die Aufrufe Befehl, Berichte und Client-Skripting-API werden durch diese Einstellung aktiviert/deaktiviert. Andere API-Aufrufe werden unter Öffentliche Portale konfiguriert.

Weitere Informationen finden Sie im API-Programmierhandbuch.

Archiv-API aktivieren

Wählen Sie, ob Sie die Status-Archiv-API aktivieren möchten, um Protokolle des Status des Geräts für Remote-Zugriff und von Ereignissen bestimmter Tage herunterzuladen.

API :: Konten

Ein API-Konto speichert alle Authentifizierungs- und Autorisierungseinstellungen für den API-Klienten. Mindestens ein API-Konto ist erforderlich, um die API zu verwenden, entweder zusammen mit dem Integrations-Client, mit einer Drittanbieter-App oder mit Ihrer intern entwickelten Software.

Vor 16.2 wurde ein Benutzerkonto zur Authentifizierung der API verwendet. Diese Methode wurde außer Kraft gesetzt, obwohl sie zur Abwärtskompatibilität noch immer für Benutzer verfügbar ist, die diese Methode bereits verwenden.

Neues API-Konto erstellen, bearbeiten, löschen

Erstellen Sie ein neues Konto, bearbeiten Sie ein bestehendes Konto oder entfernen Sie ein bestehendes Konto.

API :: Konto :: Hinzufügen oder bearbeiten

Name

Erstellen Sie einen eindeutigen Namen, um dieses Konto leichter zu identifizieren.

Kommentare

Fügen Sie Kommentare hinzu, die den Zweck dieses Kontos identifizieren.

Aktiviert

Falls aktiviert, ist dieses Konto zur API-Authentifizierung berechtigt. Wenn ein Konto deaktiviert ist, werden alle mit dem Konto verknüpften OAuth-Tokens sofort deaktiviert.

Berechtigungen

Wählen Sie die API-Bereiche, die dieses Konto verwenden können soll. Wählen Sie für die Befehls-API, ob der Zugriff verweigert, nur schreibgeschützt oder vollständig gewährt werden soll. Legen Sie unter Berichts-API fest, ob dieses Konto Zugriff auf Support-Sitzungsberichte und Aufzeichnungen, Präsentationssitzungsberichte und Aufzeichnungen, Lizenznutzungsberichte und/oder Archivberichte hat. Legen Sie darüber hinaus fest, ob dieses Konto die Sicherungs-API, die Echtzeit-Zustand-API und/oder die Endpunkt-Anmeldedaten-Manager-API verwenden kann.

Netzwerkbeschränkungen

Listet Netzwerkadresspräfixe auf, über die sich dieses Konto authentifizieren kann.

API-Konten sind nicht durch die unter /login > Verwaltung > Sicherheit konfigurierten Präfixe beschränkt. Sie sind nur durch die für das API-Konto konfigurierten Netzwerkpräfixe beschränkt.

Authentifizierungseinstellungen

Die OAuth Client-ID und das Client-Secret werden zur Erstellung von OAuth-Tokens verwendet, die für die API-Authentifizierung benötigt werden.

OAuth Client-ID

Die OAuth Client-ID ist eine eindeutige ID, die vom Gerät generiert wird. Sie kann nicht geändert werden. Die Client-ID wird als öffentliche Information erachtet und kann daher frei weitergegeben werden, ohne die Integrationssicherheit zu gefährden.

OAuth Client-Secret

Das OAuth-Client-Secret wird vom Gerät mithilfe eines kryptografisch sicheren, pseudo-zufälligen Zahlengenerators generiert.

Das Client-Secret kann nicht modifiziert werden. Sie können es auf der Seite Bearbeiten jedoch neu erzeugen. Wird ein Client-Secret neu erzeugt und das Konto dann gespeichert, werden sofort sämtliche mit dem Konto verknüpften OAuth-Tokens ungültig. Sämtliche API-Aufrufe unter Verwendung dieser Tokens können nicht mehr auf die API zugreifen.