Designen der API-Sicherheit
Als Teil des API-Designprozesses müssen Sie festlegen, welche Nutzer auf Ihre API zugreifen dürfen (Authentifizierung) und was sie tun dürfen (Autorisierung).
Vielleicht möchten Sie einfach allgemeine Sicherheit für Ihre gesamte API definieren, oder Sie entscheiden sich für eine detailliertere Richtlinie mit spezifischer Sicherheit für eine kritische Ressource.
Eventuell möchten Sie auch festlegen, dass bestimmte Vorgänge ohne Authentifizierung frei zugänglich sind.
API Designer kann all diese Fälle mit den Hauptsicherheitstypen handhaben:
- Basisauthentifizierung
- Bearer-Authentifizierung
- Digest-Authentifizierung
- OAuth 1.0
- OAuth 2.0
- OpenID Connect
- Benutzerdefiniert / API-Schlüssel
- Pass-Through
Cookie-Authentifizierung wird nicht unterstützt.
Erstellen eines Sicherheitsschemas
Erstellen Sie ein Sicherheitsschema, das global in Ihrer API-Version oder in einzelnen Elementen verwendet werden soll.
- Geben Sie weitere Parameter ein, die für den ausgewählten Typ spezifisch sind.
Ihr Sicherheitsschema wurde erstellt, Sie können es in den globalen Einstellungen Ihrer API oder in bestimmten Ressourcen und Vorgängen verwenden.
Definieren der API-Sicherheit
Definieren Sie Sicherheitsschemas für Ihre API, Ressourcen und Vorgänge.
- Fügen Sie im Abschnitt Globale Sicherheit Ihre Sicherheitsschemas hinzu und wählen Sie diejenigen aus, die Sie global auf Ihre API-Version anwenden möchten.
- Wählen Sie eine Ressource aus und wählen Sie die Sicherheitsschemas aus, die Sie auf alle Vorgänge Ihrer Ressource anwenden möchten. Alternativ können Sie einen Vorgang auswählen, um dessen spezifische Sicherheit zu definieren.
