Zum Hauptinhalt springen
Sie können Vantage-API-Clients im linken Bereich auf der Registerkarte Configuration erstellen und konfigurieren. So erstellen Sie einen API-Client:
  1. Klicken Sie auf Create API Client.
Create API Client
  1. Im daraufhin geöffneten Dialog werden die Client-ID und das Client-Secret des erstellten Clients angezeigt. Sie können die Werte speichern, indem Sie auf das Symbol daneben klicken. Alternativ können Sie auf die Schaltfläche Save to File klicken und einen Speicherort angeben, an dem eine TXT-Datei mit Client-ID und Client-Secret gespeichert wird.
Wichtig! Der Secret-Wert wird nur einmal während der Erstellung angezeigt und muss daher sofort gesichert werden. Client ID and Secret Dialog
  1. Klicken Sie auf Close.
Nach diesen Schritten werden Sie automatisch zur Bearbeitungsseite des erstellten Clients weitergeleitet. Dort können Sie Folgendes tun:
  • Den im Feld Client Name angegebenen Namen des Clients ändern.
  • Ein neues Secret erstellen, indem Sie auf Add Secret klicken. Standardmäßig wird ein Secret für 6 Monate erstellt.
  • Eine neue Redirect-URL hinzufügen, indem Sie auf Add Redirect URL klicken.
  • Die erlaubten Authentifizierungsflows im Abschnitt OAuth 2.0 Flows Settings konfigurieren. Beachten Sie, dass Sie mehr als einen Flow auswählen können:
    • Allow Authorization Code Flow. Ermöglicht die Authentifizierung über dieses sichere Verfahren, bei dem die Anwendung die Authentifizierungsanfrage direkt an den Vantage-Autorisierungsserver sendet, anstatt sie an den Benutzer zu leiten. Der Autorisierungsserver prüft die Anmeldedaten des Benutzers und stellt dem Client einen Autorisierungscode bereit. Authorization Code Flow ist für alle Vantage-API-Clients aktiviert. Bei Bedarf:
      • Wählen Sie die Option Require PKCE for Authorization Code Flow. Diese Option erhöht die Sicherheit bei der Autorisierung öffentlicher Clients. Sie ermöglicht Vantage zu prüfen, dass die Anwendung, die ein Zugriffstoken anfordert, dieselbe ist, die die Authentifizierung initiiert hat.
      • Wählen Sie Allow issuing refresh tokens to refresh access tokens. Diese Option ermöglicht die Ausgabe von Refresh Tokens, um erneuerte Zugriffstokens zu erhalten. Die Anwendung kann mithilfe der Refresh Tokens neue Zugriffstokens anfordern, ohne mit dem Benutzer zu interagieren. Anwendungen müssen Refresh Tokens sicher speichern, da sie den Benutzer angemeldet halten.
    • Allow Resource Owner Password Credentials Flow. Ermöglicht Benutzern die Authentifizierung mit Benutzername und Passwort. Dies setzt voraus, dass die Anwendung Zugriff auf das Passwort des Benutzers hat, und erfordert ein hohes Maß an Vertrauen zwischen Benutzer und Anwendung.
Hinweis: Dieser Flow funktioniert nicht, wenn ein External Identity Provider konfiguriert ist.
  • Allow client credentials flow. Ermöglicht Anwendungen die Autorisierung über den OAuth 2.0 Client Credentials Flow und gewährt ihnen Zugriff auf die Vantage-API. Die den Anwendungen zugewiesenen Rollen werden durch die Einstellung Manage Roles unter Allow client credentials flow bestimmt. Mit den angegebenen Rollen meldet sich die Anwendung bei Vantage an.
Weitere Informationen zu Authentifizierungsflows finden Sie unter Authentication. OAuth 2.0 Configuration Wenn Sie einen neuen Client erstellen möchten, wählen Sie Add Client in der Dropdown-Liste New Client. In dieser Liste werden auch alle vorhandenen Clients angezeigt; ein Klick auf einen Eintrag öffnet die Bearbeitungsseite des ausgewählten Clients. Bei Bedarf können Sie zudem nach Clientnamen und Rollen suchen. New Client Dropdown Um einen Client zu löschen, klicken Sie auf das Symbol und anschließend auf Delete Client. Delete Client