API-Modus (api)

Überblick

Der api-Modus ermöglicht direkte Aufrufe an die Passwork API mit Antworten im JSON-Format.

Syntax

shell

passwork-cli api [options]

API-Parameter

Der Befehl api erfordert die folgenden Parameter:

Parameter	Beschreibung
--method	HTTP-Methode (GET, POST, PUT, DELETE, PATCH)
--endpoint	API-Pfad (z. B. v1/vaults)
--params	JSON-String mit Parametern (optional)
--field	Feldname, der aus der Antwort extrahiert werden soll (optional)

So funktioniert es

1. Authentifizierung: Verbindet sich mit dem Passwork-Server;
2. Anfrageaufbau: Erstellt eine HTTP-Anfrage mit dem angegebenen Pfad und der angegebenen Methode;
3. Senden der Anfrage: Sendet die Anfrage mit den erforderlichen Autorisierungs-Headern;
4. Verarbeitung der Antwort: Empfängt und verarbeitet die API-Antwort;
5. Filterung (optional): Extrahiert das angegebene Feld mit --field;
6. Ausgabe: Das Ergebnis wird im JSON-Format ausgegeben.

Anwendungsbeispiele

Liste aller Tresore abrufen:

shell

passwork-cli api --method GET --endpoint "v1/vaults"

Ein Element abrufen und nur den Namen extrahieren:

shell

passwork-cli api --method GET --endpoint "v1/items/password_id" --field "name"

Elemente nach Tags suchen und aus den Treffern die Namen ausgeben:

shell

passwork-cli api \
  --method GET \
  --endpoint "v1/items/search" \
  --params '{"tags":["api","production"]}' \
  --field "name"

Rotation von accessToken und refreshToken über POST /api/v1/sessions/refresh (vollständiges Paar). Separate Endpunkte für API-Sitzungen und curl-Beispiele: API-Tokenrotation.

shell

passwork-cli api \
  --host "https://passwork.example.com" \
  --token "your_expired_token" \
  --refresh-token "your_refresh_token" \
  --method POST \
  --endpoint "v1/sessions/refresh" \
  --field "token"

Verwendung mit einem selbstsignierten Zertifikat:

shell

passwork-cli api --no-ssl-verify --method GET --endpoint "v1/user/profile"

Hinweise

• Alle Antworten werden im JSON-Format zurückgegeben;
• Mit dem Parameter --field können Sie ein bestimmtes Feld aus der Antwort extrahieren;
• Der Parameter --params wird verwendet, um Daten in POST-, PUT- und PATCH-Anfragen zu übergeben;
• Für selbstsignierte Zertifikate müssen Sie --no-ssl-verify verwenden.