Definition von OAuth 2.0
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsDefinieren der Verwendung von OAuth 2.0 in der OpenAPI-Spezifikation
Um OAuth 2.0 zur Authentifizierung verwenden zu können, beschreiben Sie die API mit OAuth 2.0. Dies geschieht mit dem sogenannten Security Scheme Object (Sicherheitsschemata).
Beispiel:
Komponenten: Sicherheitsschemata: Beliebiger Name: Typ: OAuth2 Beschreibung: Optionale Beschreibung Flows: implizit: # Autorisierungs-URL: https://api.example.com/oauth2/authorize Bereiche: etwas_lesen: Daten lesen etwas_schreiben: Daten ändern
Einzelheiten zu den OAuth 2.0-Konfigurationsoptionen und weitere Beispiele finden Sie unterdie OAuth 2.0-Dokumentation.
Definieren, bei welchen API-Operationen der konfigurierte API-Schlüssel verwendet wird
Zusätzlich zur Definition des Sicherheitsschemaobjekts für die API-Schlüsselauthentifizierung müssen Sie auch angeben, auf welche API-Operationen das definierte Sicherheitsschema angewendet werden soll.
In diesem Beispiel haben wir das Sicherheitsanforderungsobjekt (Sicherheit)-Objekt nach dem Komponentenobjekt und definierte das OAuth 2.0-Sicherheitsschema, das auf alle in dieser OpenAPI-Spezifikation definierten API-Operationen angewendet werden soll.
Das hinzugefügte Sicherheitsanforderungsobjekt (Sicherheit) ist fett markiert:
Komponenten: Sicherheitsschemata: Beliebiger Name: Typ: OAuth2 Beschreibung: Optionale Beschreibung Flows: implizit: # Autorisierungs-URL: https://api.example.com/oauth2/authorize Bereiche: etwas lesen: Daten lesen etwas schreiben: Daten ändern Sicherheit: Beliebiger Name: etwas lesen etwas schreiben
Der nächste Artikel istEinführung in die Konfiguration einer OAuth-Anwendung
Verwandte ArtikelEinführung in die Definition der Verwendung von API-Schlüsseln in der OpenAPI-SpezifikationEinführung in OAuth 2.0Einführung in API-ZugriffsrichtlinienSo verwenden Sie den OAuth 2.0-Autorisierungscodefluss mit PKCE in in Frends veröffentlichten APIsSo verwenden Sie den OAuth 2.0-Autorisierungscode in APIs, die in Frends veröffentlicht wurden