Sie können anstelle der sitzungsbasierten Authentifizierung mithilfe von Token auf die Orchestrator-APIs zugreifen. Als Operator-Superuser können Sie die API-Token verwalten. Sie können mehrere API-Token für einen Benutzer erstellen.
Hinweis: Für Enterprise Read Only- und MSP Business Specialist-Benutzer ist die tokenbasierte Authentifizierung nicht aktiviert.
Standardmäßig sind die API-Token aktiviert. Wenn Sie sie deaktivieren möchten, wechseln Sie zu
Systemeigenschaften (System Properties) im Operator-Portal und legen Sie den Wert der Systemeigenschaft
session.options.enableApiTokenAuth
als
False fest.
Hinweis: Der Operator-Superuser sollte inaktive IdP-Benutzer (Identity Provider, Identitätsanbieter) manuell aus dem Orchestrator löschen, um nicht autorisierten Zugriff über API-Token zu verhindern.
Die Benutzer können die Token basierend auf ihren Rollen erstellen, widerrufen und herunterladen.
So verwalten Sie die API-Token:
- Navigieren Sie im Operator-Portal zu .
- Wählen Sie einen Benutzer aus und klicken Sie auf Ändern (Modify) oder klicken Sie auf den Link zum Benutzernamen. Navigieren Sie zum Abschnitt API-Token (API Tokens).
- Klicken Sie auf Neues API-Token (New API Token).
- Geben Sie im Fenster Neues Token (New Token) in den Feldern Name und Beschreibung (Description) Werte für das Token ein und wählen Sie dann im Dropdown-Menü die Lebensdauer (Lifetime) aus.
- Klicken Sie auf Speichern (Save). Das neue Token wird in der Tabelle API-Token (API Tokens) angezeigt. Anfänglich wird der Status des Tokens als Ausstehend (Pending) angezeigt. Nach dem Herunterladen ändert sich der Status in Aktiviert (Enabled).
- Zum Herunterladen des Tokens wählen Sie es aus und klicken dann auf API-Token herunterladen (Download API Token).
- Zum Deaktivieren eines Tokens wählen Sie es aus und klicken auf API-Token widerrufen (Revoke API Token). Der Status des Token wird als Widerrufen (Revoked) angezeigt.
- Klicken Sie auf CSV, um die vollständige Liste der API-Token im CSV-Dateiformat herunterzuladen.
- Nach Ablauf der Lebensdauer des Tokens ändert sich der Status in Abgelaufen (Expired).
Hinweis: Nur der mit dem Token verknüpfte Benutzer kann das Token herunterladen. Nach dem Herunterladen wird nur die ID des Tokens angezeigt. Sie können ein Token nur einmal herunterladen. Nach dem Herunterladen kann der Benutzer das Token als Teil des Autorisierungs-Headers der Anforderung senden, um auf die Orchestrator-API zuzugreifen.
Das folgende Beispiel zeigt einen Beispielausschnitt des Codes für den Zugriff auf eine API.
curl -k -H "Authorization: Token <Token>" -X POST https://vco/portal/ -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'
Ebenso können Sie zusätzliche Eigenschaften konfigurieren und API-Token für Partneradministratoren, Unternehmenskunden und Partnerkunden erstellen. Weitere Informationen finden Sie unter:
- Thema „Benutzer – Kunde“ im VMware SD-WAN-Administratorhandbuch
- Thema „Benutzer – Partner“ im VMware SD-WAN-Partnerhandbuch
Im Folgenden finden Sie weitere Optionen im Abschnitt
API-Token (API Tokens):
Option | Beschreibung |
---|---|
Suchen (Search) | Geben Sie einen Suchbegriff ein, um in der Tabelle nach dem übereinstimmenden Text zu suchen. Verwenden Sie die Option für die erweiterte Suche, um die Suchergebnisse einzugrenzen. |
Spalten (Columns) | Wählen Sie mit einem Klick die Spalten aus, die auf der Seite angezeigt oder ausgeblendet werden sollen. |
Aktualisieren (Refresh) | Klicken Sie auf diese Option, um die Seite zu aktualisieren, damit die aktuellsten Daten angezeigt werden. |