Einführung in die API-Authentifizierung mit Frends

Authentifizieren von APIs

Aleksi Hytönen avatarGeschrieben vonAleksi Hytönen Vor über einer Woche aktualisiertTable of contents

API-Authentifizierung mit Frends

Frends-APIs können vier verschiedene Arten der Authentifizierung verwenden:

  • Keine - Keine Authentifizierung überhaupt

  • Basic - Authentifizieren mit HTTP-Basisauthentifizierung

  • Zertifikat - Verwenden Sie zur Authentifizierung ein Client-Zertifikat (erfordert die Verwendung eines HTTP-Triggers, kann nicht mit API-Triggern verwendet werden)

  • API-Schlüssel - Authentifizieren Sie sich mit einemAPI-Schlüssel

  • OAuth2 - Authentifizierung mit OAuth 2.0-Bearer-Tokens

Notiz
Wir empfehlen dringend, API-Operationen so anzugeben und zu konfigurieren, dass HTTPS-Anfragen nur dann akzeptiert werden, wenn die Sicherheit der API-Anmeldeinformationen und anderer Anfrage- und Antwortdaten gewährleistet ist.

Grundlegende Authentifizierungauthentifiziert den Benutzer entweder gegenüber dem Active Directory oder den lokalen Benutzern. Welche Option verwendet wird, hängt vom Benutzer des Friends Agent-Dienstes ab. Wenn der Agent ein lokales Benutzerkonto verwendet, werden Benutzer gegenüber den Benutzern des lokalen Computers authentifiziert. Wenn der Agent ein AD-Benutzerkonto verwendet, werden Benutzer gegenüber den AD-Benutzern authentifiziert. Benutzername und Passwort müssen mit UTF-8 codiert werden, bevor sie für den grundlegenden Authentifizierungsheader in Base64 konvertiert werden.

Zertifikatauthentifizierungerfordert, dass das Client-Zertifikat für den Friends-Agent-Benutzer auf dem Agent-Rechner gültig ist. Außerdem muss der Aussteller des Zertifikats im Zertifikatspeicher der Client-Authentifizierungsaussteller des Agent-Benutzers zu finden sein.

API-Schlüsselauthentifizierungverwendet einen API-Schlüssel zusammen mit einem Regelsatz, um zu bestimmen, ob der Client Zugriff auf eine API-URL hat. Eine ausführlichere Dokumentation zu API-Schlüsseln finden Sie unterAPI-SchlüsselArtikel.

OAuth2verwendet OAuth-Bearer-Token von registrierten OAuth-Anwendungen, um Zugriff auf die API zu erhalten. Sie müssen eine API-Zugriffsrichtlinie festlegen, um den Zugriff zu ermöglichen.
Wenn Sie Bereiche zur Steuerung des Zugriffs auf eine API verwenden, müssen Sie die erforderlichen Bereiche in der Swagger-Definition angeben. Bitte beachten Sie, dass Aufrufe durchgehen, wenn Sie einer API-Trigger-Operation viele Bereiche zuweisen, wenn das OAuth-Tokenbeliebigder angegebenen Bereiche.
Mehr zu OAuth erfahren Sie im KursErstellen von Friends-APIs – OAuth.

Der nächste Artikel istEinführung in API Trigger


Verwandte ArtikelOAuth-EinstellungenEinführung in API TriggerEinführung in die Authentifizierung in HTTP-IntegrationenEinführung in die Konfiguration einer Authentifizierungsmethode für eine APIEinführung in die API-Authentifizierung