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

Verwaltung

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, 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.

CLI-Client-Download

Das Tool Befehlszeilenschnittstelle (CLI - Command Line Interface) kann heruntergeladen werden, um die Verwendung und Konfiguration von APIs und Automatisierungsskripten zu erleichtern und sie in Ihre BeyondTrust Remote Support Installation zu integrieren. Das CLI-Tool ist für die Plattformen Windows (x64), macOS und Linux (x64) verfügbar. Wählen Sie die entsprechende Plattform und klicken Sie auf BTAPI CLI Client herunterladen.

Der Download ist eine komprimierte ausführbare Datei. Extrahieren Sie die Datei, und speichern oder verknüpfen Sie sie in einem ausführbaren Bereich (in Ihrem PATH).

Für Windowssysteme: Öffnen Sie die Datei in einem Terminal wie Windows Command Prompt oder Windows PowerShell.
Für macOS-Systeme: Führen Sie die Datei im Terminal aus.

Die Hilfeinformationen, einschließlich Optionen, Befehle und variable Anweisungen, werden beim Öffnen des Programms angezeigt.

Archiv-API aktivieren

Wählen Sie, ob Sie die Status-Archiv-API aktivieren möchten, um Protokolle des Status des B Series Appliance 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.

Hinzufügen, Bearbeiten, Löschen

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

Ein API-Konto hinzufügen oder bearbeiten

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.

Name

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

OAuth Client-ID

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

Die OAuth Client-ID ist eine eindeutige ID, die vom B Series Appliance 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.

Kommentare

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

OAuth Client-Secret

Das OAuth-Client-Secret wird vom B Series Appliance 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.

Berechtigungen

Wählen Sie die API-Bereiche, die dieses Konto verwenden können soll.

Befehls-API

Wählen Sie für die Befehls-API, ob der Zugriff verweigert, nur schreibgeschützt oder vollständig gewährt werden soll.

Berichts-API

Legen Sie für die Berichts-API fest, ob dieses Konto Zugriff auf Support-Sitzungsberichte und Aufzeichnungen, Präsentationssitzungsberichte und Aufzeichnungen, Lizenznutzungsberichte, Archivberichte und Vaultkonto-Aktivitätsberichte hat.

Sicherungs-API

Legen Sie fest, ob dieses Konto die Sicherungs-API verwenden kann.

API-Konfiguration

Legen Sie fest, ob dieses Konto die Konfigurations-API verwenden kann und ob es in diesem Fall Vaultkonten verwalten kann.

Echtzeit-Status-API

Legen Sie fest, ob dieses Konto die Echtzeit-Status-API verwenden kann.

Endpunkt-Anmeldedaten-Manager-API

Legen Sie fest, ob dieses Konto 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.

Netzwerkadressen-Zulassungsliste

Geben Sie die Netzwerkadressen ein, die Sie auf die Zulassungsliste setzen möchten.