Authentifizierung verwalten

Die Vonage CLI verwendet ein flexibles Konfigurationssystem zur Verwaltung Ihrer API-Anmeldeinformationen. Es unterstützt lokale oder globale Konfigurationsdateien und Befehlszeilen-Flags, um diese Werte zu überschreiben, so dass Sie Ihre Einrichtung an Ihre Projektanforderungen oder persönlichen Vorlieben anpassen können.

Konfiguration

Die CLI lädt die Konfiguration in der folgenden Reihenfolge:

  1. Befehlszeilen-Flags --api-key, --api-secret, --private-keyund --app-id.
  2. Eine lokale Konfigurationsdatei im aktuellen Arbeitsverzeichnis .vonagerc.
  3. Eine globale Konfigurationsdatei in der .vonage Ordner in Ihrem Heimatverzeichnis $HOME/.vonage/config.json.

Anmerkung: Nur die CLI liest diese Werte aus .vonagerc. Die Vonage SDKs erfordern eine separate Initialisierung mit ihren eigenen Anmeldedaten.

Hinweis: Der Inhalt des privaten Schlüssels wird in der Konfigurationsdatei gespeichert. Damit soll sichergestellt werden, dass der Schlüssel nicht überschrieben wird, wenn neue Schlüssel erzeugt werden.

Flaggen

Flagge Beschreibung Typ
--app-id Die ID der zu verwendenden Applikation. Diese ist im Abschnitt "Applications" des Dashboards zu finden oder wird ausgegeben mit vonage apps. Zeichenfolge
--privateKey Der Pfad oder Inhalt des privaten Schlüssels. Der Zugriff auf den privaten Schlüssel ist nur möglich, wenn die Anwendung erstellt wird oder wenn Sie die Schlüssel im Dashboard neu generieren. Zeichenfolge
--apiKey Der API-Schlüssel, den Sie im Abschnitt "API-Einstellungen" Ihres Dashboards finden. Zeichenfolge
--apiSecret Das API-Geheimnis finden Sie im Abschnitt "API-Einstellungen" Ihres Dashboards. Zeichenfolge

Authentifizierung einstellen

Sie können die Befehlszeilenschnittstelle zwar auch ohne Konfiguration verwenden, müssen aber beim Ausführen eines Befehls die Flags angeben.

Die Verwendung des vonage auth set wird empfohlen, damit Sie sie nicht jedes Mal eingeben müssen, wenn Sie einen Befehl ausführen.

Flaggen

Dabei werden die oben aufgeführten Flags in Konfiguration.

Beispiel

vonage auth set `
--api-key='your-api-key' `
--api-secret='your-api-secret' `
--app-id='your-application-id' `
--private-key=C:\path\to\private.key

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Hinweis: Laufen vonage auth set werden die aktuellen Werte nicht entfernt. Daher können Sie nur den API-Schlüssel/Geheimnis oder die App-ID/den privaten Schlüssel einzeln festlegen. Sie können jedoch die App-ID und den privaten Schlüssel nicht festlegen, ohne den API-Schlüssel und das Geheimnis festgelegt zu haben. Dies liegt daran, wie der Befehl die Gültigkeit der Anmeldeinformationen überprüft.

Hinweis: Mit diesem Befehl wird auch geprüft, ob die Anmeldedaten korrekt sind, bevor sie übertragen werden.

Authentifizierung prüfen

Überprüfen Sie, ob Ihre Authentifizierungsdaten gültig sind. Standardmäßig wird dazu die globale Konfigurationsdatei verwendet. Die Überprüfung der Anmeldeinformationen funktioniert wie folgt:

  1. Der API-Schlüssel und das Geheimnis werden durch einen Aufruf zur Auflistung der Applications mit der Funktion Applications API.
  2. Die App-ID und der private Schlüssel werden validiert, indem die Anwendungsinformationen abgerufen werden und der öffentliche Schlüssel zusammen mit dem privaten Schlüssel verwendet wird, um sicherzustellen, dass sie korrekt gepaart sind.

Hinweis: Bei diesem Befehl werden die Befehlszeilenargumente nicht verwendet. Es werden nur die Konfigurationsdateien überprüft.

Flaggen

Flagge Beschreibung
--local Verwenden Sie die lokale Konfigurationsdatei (.vonagerc)

Beispiel

Überprüfen Sie die globale Konfiguration:

vonage auth check 

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Überprüfen Sie die lokale Konfiguration:

vonage auth check --local

Global credentials found at: .vonagerc

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Authentifizierung anzeigen

Zeigen Sie Ihre aktuelle Authentifizierungskonfiguration an. Dies erfolgt nach dem Laden der erwähnten Konfiguration über und teilt Ihnen mit, welche Konfigurationsdatei die CLI verwendet.

Hinweis: Mit diesem Befehl wird auch geprüft, ob die Anmeldedaten korrekt sind.

Flaggen

Flagge Beschreibung
--show-all Nicht redigierten privaten Schlüssel und API-Geheimnis anzeigen.
--yaml Ausgabe im YAML-Format.
--json Ausgabe im JSON-Format.

Beispiel

vonage auth show

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key