Erstellen, Konfigurieren und Löschen eines Public API-Clients

1. Klicken Sie in Vantage auf Configuration.
2. Klicken Sie im Dialogfeld Tenant Adminstration auf Create API Client.

2. Um jeden der Werte zu kopieren, klicken Sie auf das Kopiersymbol daneben. Alternativ klicken Sie auf Save to File, um eine TXT-Datei mit beiden Werten herunterzuladen.

Wichtig! Der Secret-Wert wird nur einmal während der Erstellung des Clients angezeigt und muss daher sofort gespeichert werden.

3. Klicken Sie auf Close.
   Die Seite Public API Client wird angezeigt.

1. Klicken Sie in Vantage auf Configuration.
2. Klicken Sie im Dialogfeld Tenant Adminstration auf Public API Client.
3. Klicken Sie auf der Seite Public API Client auf die Dropdown-Liste New Client und dann auf Add Client.

4. Um jeden Wert zu kopieren, klicken Sie auf das Copy-Icon neben jedem Wert. Alternativ klicken Sie auf Save to File, um eine TXT-Datei mit beiden Werten herunterzuladen.

Wichtig! Der Secret-Wert wird nur einmal während der Client-Erstellung angezeigt. Er muss daher sofort gespeichert werden.

5. Klicken Sie auf Close.
   Die Seite Public API Client wird angezeigt.

1. Geben Sie im Feld Client Name den Namen des neuen Public API-Clients ein.

2. Um ein neues Secret zu erstellen, klicken Sie auf Add Secret. Standardmäßig wird ein Secret für einen Zeitraum von 6 Monaten erstellt. Sie können die Gültigkeitsdauer ändern und sie auf bis zu 36 Monate festlegen.
3. Um eine neue Redirect-URL hinzuzufügen, klicken Sie auf Add Redirect URL.
4. Konfigurieren Sie die zulässigen Authentifizierungsflows im Abschnitt OAuth 2.0 Flows Settings.
   Hinweis: Dieser Flow funktioniert nicht, wenn ein External Identity Provider konfiguriert ist.
   Sie können mehr als einen Flow auswählen:
   • Allow Authorization Code Flow. Ermöglicht die Authentifizierung mithilfe dieses sicheren Authentifizierungsschemas, bei dem die Anwendung die Authentifizierungsanforderung direkt an den Vantage-Autorisierungsserver sendet, anstatt sie über den Benutzer zu leiten. Der Autorisierungsserver überprüft dann die Anmeldedaten des Benutzers und stellt dem Client einen Authorization Code zur Verfügung. Authorization Code Flow ist für alle Vantage-API-Clients aktiviert. Bei Bedarf:
     • Wählen Sie die Option Require PKCE for Authorization Code Flow aus. Diese Option erhöht die Sicherheit bei der Autorisierung von Public Clients. Sie ermöglicht Vantage zu überprüfen, dass die Anwendung, die ein Access Token anfordert, dieselbe ist, die die Authentifizierung initiiert hat.
   • Allow Resource Owner Password Credentials Flow. Ermöglicht Benutzern die Authentifizierung mit ihrem Benutzernamen und Kennwort. Dies setzt voraus, dass die Anwendung Zugriff auf das Kennwort des Benutzers hat, und erfordert ein hohes Maß an Vertrauen zwischen dem Benutzer und der Anwendung.
   • Wählen Sie Allow issuing refresh tokens to refresh access tokens. Diese Option ermöglicht das Ausstellen von Refresh Tokens, um erneuerte Access Tokens zu erhalten. Die Anwendung kann mithilfe der Refresh Tokens neue Access Tokens anfordern, ohne mit dem Benutzer zu interagieren. Anwendungen müssen Refresh Tokens sicher speichern, da sie es dem Benutzer ermöglichen, angemeldet zu bleiben.
5. Allow client credentials flow. Ermöglicht Anwendungen, mithilfe des OAuth 2.0 Client Credentials Flow autorisiert zu werden und gewährt ihnen Zugriff auf die Vantage-API. Die den Anwendungen zugewiesenen Rollen werden über die Einstellung Manage Roles unterhalb von Allow client credentials flow festgelegt. Mit den angegebenen Rollen meldet sich die Anwendung bei Vantage an.
6. Konfigurieren Sie die Token Lifetime Settings:
   • Access Token. Legt den Zeitraum fest, in dem das ausgegebene Access Token dem Benutzer Zugriff auf Vantage gewährt. Die Standardlebensdauer eines Access Tokens beträgt 24 Stunden.
   • Refresh Token. Legt den absoluten Zeitraum ab der Ausgabe des ersten Access Tokens fest, in dem das ausgegebene Refresh Token zum Erneuern des Access Tokens verwendet werden kann. Die Standardlebensdauer eines Refresh Tokens beträgt 30 Tage.