Zum Inhalt springen
Geprüft

Hygiene bei API-Schlüsseln

Vollzugriff oder benutzerdefinierter Zugriff, einen Schlüssel widerrufen und ersetzen und einen erkennen, den niemand nutzt.

Ein API-Schlüssel handelt für dein Konto, ohne dass du dabei bist: von überall, bis er widerrufen wird. Authentifizierung behandelt, wie ein Schlüssel erstellt und bei einem Aufruf gesendet wird; diese Seite handelt davon, die Schlüssel, die du schon hast, in Ordnung zu halten.

Gib einem Schlüssel nur, was er braucht

Jeder Schlüssel hat Vollzugriff oder Benutzerdefinierten Zugriff, bei der Erstellung gewählt und später im selben Formular änderbar.

  • Vollzugriff erreicht jede Methode, die dein Konto aufrufen kann, auch solche, die nach der Erstellung des Schlüssels hinzukamen. Nichts, was als privat markiert ist, wird je einbezogen, egal welchen Zugriffsmodus ein Schlüssel hat.
  • Benutzerdefinierter Zugriff erreicht nur die Methoden, die du ausdrücklich angehakt hast, nach Microservice gruppiert, mit den eigenen Parametern jeder Methode daneben. Eine später hinzugekommene Methode ist nicht abgedeckt, bis du zurückkommst und sie ankreuzt.
Bevorzuge benutzerdefinierten Zugriff für alles Automatisierte

Ein Schlüssel, der in ein Skript, einen CI-Job oder einen Server eingebunden ist, braucht nur die wenigen Methoden, die dieser Job tatsächlich aufruft. Benutzerdefinierter Zugriff verhindert, dass ein geleakter Schlüssel mehr tun kann als die Arbeit, für die er gebaut wurde.

Erstellen, anzeigen und kopieren

Um einen Schlüssel zu erstellen, muss dein Konto auf Stufe 2 verifiziert sein; siehe Verifizierung. Die Schaltfläche Schlüssel erstellen erklärt das und verlinkt direkt auf den nächsten offenen Schritt, wenn du noch nicht so weit bist. Der Wert eines neu erstellten Schlüssels wird einmal im Bereich Schnellkopie oben in der Liste angezeigt; danach hält jede Zeile ihn maskiert, und die eigene Anzeigeschaltfläche einer Zeile zeigt ihn noch einmal für 20 Sekunden, bevor er sich selbst wieder maskiert.

Ein Schlüssel ist ein Geheimnis, keine Bezeichnung

Der Wert wird nie in ein Protokoll, einen Toast oder die Adressleiste geschrieben, nur in deine Zwischenablage. Behandle ihn genau wie ein Passwort. Jeder, der ihn hat, kann als dein Konto handeln.

Ersetzen, widerrufen und einen ungenutzten erkennen

Es gibt keine separate Rotationsaktion, denn der Wert eines Schlüssels ist seine eigene Kennung. Ersetzen erstellt einen neuen Schlüssel mit demselben Namen und Zugriff, widerruft den alten und zeigt den neuen Wert einmal an, damit du ihn vor dem Schließen des Dialogs kopieren kannst. Widerrufen entfernt einen Schlüssel endgültig und bittet dich zuerst, das mit seinem Namen zu bestätigen, da es sich nicht rückgängig machen lässt.

Die Zeile jedes Schlüssels zeigt, wann er zuletzt verwendet wurde, aus der Aktivität der letzten 7 Tage abgeleitet; ein Schlüssel ohne Zeile darunter hat in diesem Zeitraum schlicht keinen Aufruf gemacht. Das ist die Zeile, die einen zweiten Blick wert ist.

Einen Schlüssel ersetzen, der geleakt sein könnte

Öffne den Schlüssel, drücke Ersetzen und kopiere den neuen Wert, sobald er erscheint. Der alte Wert funktioniert in dem Moment nicht mehr, in dem das Ersetzen abgeschlossen ist.

Einen Schlüssel widerrufen, den du nicht mehr brauchst

Drücke Widerrufen in seiner Zeile und bestätige es mit dem Namen. Ein widerrufener Schlüssel verschwindet aus der aktiven Liste; es gibt keine Möglichkeit, ihn zurückzuholen.

Nach einem ungenutzten suchen

Suche in der Liste nach einer Zeile ohne "Zuletzt verwendet"-Angabe, besonders unter den Schlüsseln mit Vollzugriff, und widerrufe sie, wenn du sie dir nicht erklären kannst.