Das API-Token für den BrynQ Agent

Das API-Token für den BrynQ Agent

Was ist das Agent-Token?

Der BrynQ Agent braucht einen Schlüssel, um zu funktionieren: ein BrynQ-API-Token, das zu Ihrer BrynQ-Umgebung gehört. Sie fügen es einmal bei der Installation des Agent ein. Der Agent speichert es auf dem Server und weist BrynQ damit nach, zu welchem Kunden er gehört.

Ohne gültiges Token kann der Agent keine sichere Verbindung zu BrynQ aufbauen und sich nicht aktualisieren.

Wofür das Token verwendet wird

WannWas das Token tut
Bei der InstallationBrynQ prüft das Token und ermittelt den Kunden, zu dem es gehört. Danach richtet BrynQ die sichere Verbindung und die eigene Adresse Ihres Agent ein: https://<ihr-kunde>.brynq-agent.com.
Automatische UpdatesDer Agent sucht mit dem Token nach neuen Versionen und lädt sie bei BrynQ herunter.
VerbindungstestDie Seite BrynQ-Verbindung des lokalen Admin-Dashboards testet mit dem Token, ob BrynQ diesen Agent akzeptiert.
Eingehende AnfragenDer Agent akzeptiert nur Anfragen für Ihren Kunden. Anfragen für einen anderen Kunden werden abgelehnt, auch mit einem gültigen Token.
ℹ️ Gut zu wissen: das Token ist nicht das Passwort Ihres lokalen Systems (SQL Server, Active Directory, Sage). Diese Einstellungen geben Sie separat im Installer oder im Admin-Dashboard ein.

Welches Token Sie brauchen

Der Agent akzeptiert nur ein Token, das mit genau einem Kunden verknüpft ist: dem Kunden, für den der Agent installiert wird.

  • ✅ Ein Token, das in Ihrer eigenen BrynQ-Umgebung erstellt wurde.
  • ❌ Ein persönliches Token oder Administrator-Token mit Zugriff auf mehrere Kunden oder auf keinen. BrynQ lehnt es ab, und der Installer meldet, dass es kein Agent-Token ist.
  • ❌ API-Zugangsdaten mit Client ID und Client Secret. Der Agent braucht ein einzelnes Token, keine Client ID und kein Secret.

So erhalten Sie das Token

Bitten Sie Ihren BrynQ-Berater oder den BrynQ-Support um das Agent-Token Ihrer Umgebung. BrynQ erstellt es für Sie und übermittelt es sicher.

Vereinbaren Sie vor dem Erstellen des Tokens:

  • Gültigkeitsdauer. Ein Token kann 30, 90, 180 oder 365 Tage gültig sein oder kein Ablaufdatum haben. Läuft das Token ab, kann sich der Agent nicht mehr aktualisieren und seine Verbindung nicht neu aufbauen. Vereinbaren Sie, wer das Token rechtzeitig ersetzt.
  • IP-Whitelist (optional). Das Token kann auf bestimmte IP-Adressen beschränkt werden. Wenn Sie das möchten, nennen Sie BrynQ die öffentliche IP-Adresse, mit der Ihr Server ins Internet geht. Der Installer und das Admin-Dashboard zeigen diese Adresse. Lassen Sie die Whitelist leer, wenn Ihr Server keine feste öffentliche Adresse hat.
⚠️ Halten Sie das Token geheim. BrynQ zeigt ein Token nur einmal an, beim Erstellen. Behandeln Sie es wie ein Passwort: Teilen Sie es nicht in Chats oder E-Mails mit Personen, die es nicht brauchen, und speichern Sie es nicht in einem gemeinsam genutzten Dokument.

Für BrynQ-Berater

  1. Öffnen Sie die Umgebung des Kunden in BrynQ.
  2. Klicken Sie in der Seitenleiste unter Entwickler auf API-Zugangsdaten.
  3. Öffnen Sie die Registerkarte Legacy-Token (markiert mit v2).
    Die Registerkarte Legacy-Token (v2) auf der Seite API-Zugangsdaten
  4. Klicken Sie auf Legacy-Token erstellen. Geben Sie eine eindeutige Bezeichnung ein, zum Beispiel BrynQ Agent – <Servername>, wählen Sie die Gültigkeitsdauer und fügen Sie, falls vereinbart, die öffentliche IP-Adresse des Servers unter Erlaubte IP-Adressen hinzu (nach jeder Adresse Enter drücken). Klicken Sie dann im Dialog auf Legacy-Token erstellen.
    Der Dialog Legacy-Token erstellen
  5. Kopieren Sie das Token sofort und klicken Sie auf Ich habe mein Token gespeichert.
Roadmap: Der Agent verwendet vorerst ein Legacy-Token (v2). Künftig verwendet er stattdessen API-Zugangsdaten (v1). Dieser Artikel wird aktualisiert, sobald sich das ändert.

Verwenden Sie kein Token von der Seite Admin Portal › API-Zugriff: Das sind Administrator-Token für alle Kunden, und der Agent lehnt sie ab.

Das Token bei der Installation eingeben

  1. Starten Sie den Installer des BrynQ Agent (die vollständige Installation finden Sie unter BrynQ Agent installieren).
  2. Fügen Sie das Token auf der Seite Cloud-Verbindung in das Feld API-Token ein. Das Feld ist maskiert.
  3. Der Installer prüft das Token bei BrynQ, während Sie tippen. Weiter ist erst verfügbar, wenn BrynQ es akzeptiert. Der Kunde wird automatisch anhand des Tokens ermittelt.
  4. Schließen Sie die Installation ab. Der Agent speichert das Token auf dem Server, geschützt mit Windows-Verschlüsselung (DPAPI). Es wird nie in Protokolle geschrieben und nicht erneut angezeigt.

Bei einer Neuinstallation oder einem Upgrade erkennt der Installer, dass bereits ein Token gespeichert ist. Lassen Sie Vorhandenes API-Token behalten (empfohlen) ausgewählt, oder wählen Sie Durch ein neues API-Token ersetzen und fügen Sie das neue ein.

Ein abgelaufenes oder widerrufenes Token ersetzen

Sie müssen den Agent nicht neu installieren, um das Token zu ersetzen.

  1. Bitten Sie BrynQ um ein neues Agent-Token.
  2. Öffnen Sie das lokale Admin-Dashboard auf dem Agent-Server.
  3. Gehen Sie zur Seite BrynQ-Verbindung.
  4. Fügen Sie unter API-Token ersetzen das Token in Neues API-Token ein und klicken Sie auf Prüfen und speichern.

BrynQ prüft das neue Token zuerst. Es wird nur gespeichert, wenn BrynQ es für Ihren Kunden akzeptiert. Ein falsches Token ersetzt also nie ein funktionierendes.

Fehlerbehebung

Der Installer und die Seite BrynQ-Verbindung zeigen, warum BrynQ ein Token nicht akzeptiert. Andere Probleme: siehe Fehlerbehebung für den BrynQ Agent.

MeldungBedeutungWas tun
BrynQ kennt dieses API-Token nicht (TOKEN_NOT_FOUND)Das Token existiert nicht, wurde widerrufen oder nicht vollständig kopiert.Kopieren Sie das ganze Token erneut. Weiterhin abgelehnt? Bitten Sie BrynQ um ein neues Token.
Das API-Token ist abgelaufen (TOKEN_EXPIRED)Die Gültigkeitsdauer des Tokens ist vorbei.Bitten Sie BrynQ um ein neues Token und ersetzen Sie es auf der Seite BrynQ-Verbindung.
Der BrynQ-Benutzer, zu dem dieses API-Token gehört, existiert nicht mehr (RELATED_USER_NOT_FOUND)Das Token wurde von einem BrynQ-Benutzer erstellt, der inzwischen entfernt wurde.Bitten Sie BrynQ um ein neues Token.
BrynQ akzeptiert dieses API-Token nur von anderen IP-Adressen (IP_NOT_ALLOWED)Das Token hat eine IP-Whitelist, die die öffentliche IP-Adresse Ihres Servers nicht enthält.Bitten Sie BrynQ, die unter Öffentliche IP-Adresse angezeigte Adresse zur Whitelist des Tokens hinzuzufügen oder die Whitelist zu entfernen. Klicken Sie dann auf Erneut prüfen.
BrynQ kennt das Token, aber es ist kein Agent-Token (AGENT_TOKEN_MUST_TARGET_EXACTLY_ONE_CUSTOMER)Das Token ist mit mehreren Kunden oder mit keinem verknüpft, zum Beispiel ein Administrator-Token.Verwenden Sie ein Token, das in Ihrer eigenen BrynQ-Umgebung erstellt wurde (siehe Welches Token Sie brauchen).
BrynQ verknüpft das Token mit einem anderen KundenDas Token gehört zu einer anderen BrynQ-Umgebung als dieser Agent.Verwenden Sie das Agent-Token Ihrer eigenen Umgebung.
Die BrynQ-Plattform antwortet nichtBrynQ ist vorübergehend ausgelastet oder nicht verfügbar.Warten Sie einige Minuten und klicken Sie auf Erneut prüfen.
BrynQ ist nicht erreichbarDer Server kann keine ausgehende HTTPS-Verbindung zu BrynQ aufbauen.Bitten Sie Ihren IT-Administrator, ausgehenden HTTPS-Verkehr zu BrynQ zu erlauben (siehe unten), auch über einen eventuellen Proxy.

Die Adresse von BrynQ für Ihre Firewall

Die Tokenprüfung, der Verbindungstest und die Updates gehen alle ausgehend von Ihrem Server zu BrynQ. Ein eingehender Port ist nicht nötig. Erlaubt Ihre Firewall oder Ihr Proxy ausgehenden Verkehr nur zu freigegebenen Zielen, erlauben Sie:

ZielIP-AdressePort
app.brynq.com20.54.225.251TCP 443 (HTTPS)

Erlauben Sie den Hostnamen app.brynq.com, wenn Ihre Firewall das unterstützt, und die IP-Adresse, wenn sie nur IP-Adressen akzeptiert. Die Prüfung Ausgehende Verbindungen auf der Seite Fehlerbehebung des Admin-Dashboards zeigt, ob der Server BrynQ erreicht. Der Cloudflare Tunnel braucht einen eigenen ausgehenden Port: siehe Netzwerkeinstellungen des BrynQ Agent.

Verwechseln Sie die beiden Adressen nicht: 20.54.225.251 ist die Adresse von BrynQ, die Ihre Firewall erlaubt. Die Öffentliche IP-Adresse Ihres Servers ist die, die BrynQ zur IP-Whitelist des Tokens hinzufügt.

Verwandte Artikel