lizard keys

Erstelle, liste und lösche API-Schlüssel. Alias: lizard apikey.

Verwendung

lizard keys create <name> [flags]
lizard keys list
lizard keys rm <name-or-id> [flags]

API-Schlüssel beginnen mit liz_. Verwende einen überall dort, wo du dich nicht über den Browser anmelden kannst:

  • LIZARD_TOKEN oder LIZARD_API_KEY für die CLI in CI
  • lizard login --token liz_… auf einem Rechner
  • LIZARD_API_KEY für das Lizard SDK
  • lizard sandbox create --with-token liz_…, um lizard innerhalb einer Sandbox anzumelden; siehe Schlüssel in einer Sandbox

Unterbefehle

lizard keys create <name>

Erstellt einen Schlüssel und gibt ihn einmalig aus. Kopiere ihn sofort; Lizard zeigt ihn nicht erneut an. Ein Schlüssel ohne Bereichseinschränkung hat vollen Zugriff auf jeden Workspace und jedes Projekt, die du erreichen kannst. Schränke ihn mit diesen Flags ein, die jeweils mehrfach angegeben werden können:

FlagBeschreibung
-p, --project <id>Beschränkt den Schlüssel auf dieses Projekt (Name, Slug oder ID)
-w, --workspace <id>Beschränkt den Schlüssel auf diesen Workspace (Name, Slug oder ID)

Ein eingeschränkter Schlüssel funktioniert nur in seinen Projekten oder Workspaces. Er kann nicht:

  • Abrechnung, Plan, Karten oder die Nutzung des ganzen Kontos sehen
  • API-Schlüssel erstellen, auflisten oder löschen; lizard keys schlägt mit ihm fehl
  • einen Workspace erstellen, seinen Workspace umbenennen oder löschen oder Workspace-Limits und Wiederverkaufspreise ändern
  • Mitglieder von Workspaces oder Projekten sehen oder verwalten
  • einen Service auf ein privates GitHub-Repository zeigen lassen, außer eine App in seinem Bereich baut bereits daraus

Mit einem eingeschränkten Schlüssel angemeldet, zeigt lizard whoami die Bereiche des Schlüssels, nicht das Konto dahinter. Hat der Owner des Workspace Wiederverkaufspreise festgelegt, sieht der Schlüssel diese Preise.

lizard keys list

Listet deine Schlüssel mit kurzer Vorschau, Bereich, Erstellungszeitpunkt und letzter Verwendung auf (Alias ls). Die Vorschau ist nicht der Anfang des Schlüssels; ordne Schlüssel daher über Name oder ID zu.

lizard keys rm <name-or-id>

Löscht einen Schlüssel (Alias delete). Wenn zwei Schlüssel denselben Namen haben, lösche per ID.

FlagBeschreibung
-y, --yesBestätigung überspringen

Beispiele

Einen Schlüssel für CI erstellen

lizard keys create github-actions --project my-project

Speichere den ausgegebenen Schlüssel als CI-Secret mit dem Namen LIZARD_TOKEN.

lizard in einer Sandbox anmelden

lizard sandbox create --with-token liz_xxx

Die Sandbox bekommt einen eigenen neuen Schlüssel, beschränkt auf das Projekt der Sandbox und mit ihr gelöscht. In lizard keys list erscheint er als sandbox-session:<sandbox-id>. Der liz_-Schlüssel, den du übergibst, autorisiert nur die Anfrage und gelangt nie in die Sandbox. Mit --with-token ohne Wert nimmt die CLI den Schlüssel, mit dem du angemeldet bist; das muss ein liz_-Schlüssel sein.

Einen Schlüssel löschen

lizard keys rm github-actions --yes

Siehe auch

Aktualisiert