Neu: Die KI-Firewall überwacht die gesamte Plattform und erklärt jeden Vorfall in einfachen Worten. So funktioniert es

Härtung von API-Schlüsseln

Geben Sie jeder Integration einen Schlüssel mit nur den nötigen Berechtigungen, einem Netz, einem Ablaufdatum und einem Eigentümer – sowie Anleitungen zum Rotieren, Widerrufen und Überwachen von Schlüsseln.

Ein API-Schlüssel ist ein Passwort für ein Programm. Wer ihn besitzt, kann alles tun, was der Schlüssel darf, von überall, wo der Schlüssel akzeptiert wird, bis er abläuft. Diese Seite zeigt, wie der Schaden bei einem abgeflossenen Schlüssel gering gehalten wird. Wie Schlüssel erstellt und die API aufgerufen wird, steht unter Authentifizierung.

Schlüssel werden unter API Keys im Bereich Developer des Menüs verwaltet (Admin; zum Rotieren wird die Rolle Owner benötigt).

Was ein Schlüssel niemals darf

Diese Grenzen gelten für jeden Schlüssel, unabhängig davon, was Sie ankreuzen:

  • Ein Schlüssel geht nie über das hinaus, was das Mitglied, das ihn erstellt hat, jetzt darf: „Er geht nie über das hinaus, was sein Eigentümer jetzt darf.“ Verliert das Mitglied eine Berechtigung, verliert sie der Schlüssel ebenfalls.
  • Ein Schlüssel besitzt nie Berechtigungen, die nur dem Owner vorbehalten sind, und nie Berechtigungen der Identitäts- und Zugriffsmodule (Anmeldung, Konten, API-Schlüssel). Daher kann ein Schlüssel keine Schlüssel erstellen oder rotieren und keine Mitglieder ändern.
  • Die Berechtigung eines Schlüssels wirkt nur, solange ihr Modul für Ihre Organisation aktiviert ist.
  • Eine Anfrage, die einen Schlüssel enthält, wird nur als dieser Schlüssel beurteilt; ein Browser-Cookie in derselben Anfrage wird ignoriert.

1. Nur die nötigen Berechtigungen vergeben

Wählen Sie unter New API Key die Module permissions nacheinander für jedes Modul aus. Jedes Modul bietet eine Voreinstellung Read only. Typische Integrationen:

IntegrationBerechtigungen
Ein Reporting-Tool, das Geräte und Historie liestRead only für Geräte und Telemetrie
Ein ERP-System, das Grenzwerte auf Geräte schreibtGeräte lesen, Attribute schreiben
Ein Ticketsystem, das Alarme quittiertAlarme lesen, quittieren

Verwenden Sie nicht einen Schlüssel für alles. Ein Schlüssel pro Integration macht klar, was ein Leck offenlegt, und erlaubt es, eine Integration zu sperren, ohne die anderen zu stoppen.

Integrationsbereiche (Read, Write, Admin, SCIM Read, SCIM Write) sind für Maschinen-Endpunkte mit eigenem Vertrag gedacht, etwa die SCIM-Bereitstellung. „Die oben genannten Modulberechtigungen brauchen die meisten Integrationen.“

2. Schlüssel an Netze binden

IP allowlist (optional): „Ein Subnetz pro Zeile, z. B. 10.0.0.0/8 oder 203.0.113.7/32.“ Aufrufe von anderswo werden mit derselben Antwort wie bei einem unbekannten Schlüssel abgelehnt, sodass ein Angreifer nichts erfährt.

Ihre Organisation kann einen Standard für Schlüssel ohne eigene Liste festlegen: API Key Settings > Tenant Subnet Allowlist.

3. Ablaufen lassen

Jeder Schlüssel läuft ab: standardmäßig nach 90 Tagen, höchstens nach 365 Tagen („Standardmäßig 90 Tage, höchstens ein Jahr.“). Unter API Key Settings:

EinstellungStandardVerwendung
Maximum Key Lifetime (days)0 (die Obergrenze von 365 Tagen)Senken Sie den Wert, um kürzere Laufzeiten zu erzwingen. Dadurch sinkt auch der Standard.
Require Expiry on Every KeyAusAPI-Aufrufe, die Schlüssel erstellen, müssen ein Ablaufdatum angeben.
Max Active Keys0 (unbegrenzt)Begrenzt, wie viele Schlüssel gleichzeitig aktiv sein können.
Per-Key Rate Limit (requests/minute)0 (der Plattform-Standard: 1.000 pro Minute)Standard-Anfragelimit jedes Schlüssels. Die Anzeige nennt 0 unbegrenzt; die Plattform wendet 1.000 pro Minute an.

4. Den Eigentümer des Schlüssels festlegen

Ein Schlüssel funktioniert nicht mehr, wenn das Mitglied, das ihn erstellt hat, die Organisation verlässt, es sei denn, er ist als Service key markiert („Ja: überlebt seinen Ersteller“). Markieren Sie Schlüssel von Produktivintegrationen als Service-Schlüssel und halten Sie fest, wer für jeden verantwortlich ist.

5. Regelmäßig rotieren

Rotate key erstellt einen Nachfolger: „Erstellen Sie einen Nachfolgeschlüssel, der die Bereiche und die Umgebung dieses Schlüssels übernimmt. Während des Übergangszeitraums funktionieren beide Schlüssel, damit Sie ohne Ausfall umstellen können.“ Legen Sie die Grace window (days) fest; 0 widerruft den alten Schlüssel sofort. Die Karte Rotation history verknüpft Vorgänger und Nachfolger.

  1. Rotieren Sie und kopieren Sie das neue Geheimnis („Schlüssel rotiert. Kopieren Sie das neue Geheimnis jetzt.“).
  2. Tragen Sie den neuen Schlüssel in die Integration ein.
  3. Prüfen Sie, ob sich Last used und Last used IP am alten Schlüssel nicht mehr ändern.
  4. Lassen Sie den Übergangszeitraum enden oder widerrufen Sie den alten Schlüssel.

6. Im Zweifel sofort widerrufen

  • Revoke Key: „Alle Integrationen, die diesen Schlüssel verwenden, werden sofort aufhören zu funktionieren. Diese Aktion kann nicht rückgängig gemacht werden.“
  • Deactivate stoppt einen Schlüssel, den Sie eventuell wieder haben möchten; Activate startet ihn wieder.
  • Im Ernstfall kann ein Owner mehrere oder alle Schlüssel gemeinsam widerrufen.

7. Die Schlüssel überwachen

SignalWo
Last used, Last used IP, Total verificationsDie Seite des Schlüssels
Ein ruhender Schlüssel wird plötzlich von einer neuen Adresse genutztEin Audit-Ereignis (api_key.anomaly.detected)
Fehlgeschlagene VerifizierungenAudit-Ereignisse (api_key.verify.failed)
Erstellung, Rotation, Löschung, BerechtigungsänderungenDas Audit-Log (api_key.created, api_key.rotated, api_key.deleted)
MissbrauchDie AI-Firewall protokolliert Vorfälle zu Schlüsseln und kann einen Schlüssel drosseln oder widerrufen. Siehe Die AI-Firewall.

Die Schlüsselliste zeigt außerdem einen Hinweis für alte Schlüssel, die vor den Modulberechtigungen erstellt wurden: Öffnen Sie jeden einzelnen und vergeben Sie nur die Modulberechtigungen, die er benötigt.

Aufbewahrung von Schlüsseln

  • Bewahren Sie Schlüssel im Geheimnisspeicher Ihrer Integration auf, niemals im Quellcode, in URLs oder in Tickets.
  • Verwenden Sie test-Schlüssel für Testsysteme, damit sie nicht mit Produktivschlüsseln verwechselt werden können.
  • Wenn ein Schlüssel abgeflossen ist, widerrufen Sie ihn zuerst und ermitteln Sie danach im Audit-Log, von wo er verwendet wurde.