Autorisieren von API-Aufrufen in Swagger

Zugreifen auf Swagger

Wenn Sie Ihre API mit Swagger ausprobieren, brauchen Sie sich nur auf einer separaten Registerkarte bei Orchestrator anzumelden.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/.

Abrufen eines Zugriffstokens

Um API-Aufrufe über die Swagger-Benutzeroberfläche für Orchestrator-Dienste zu autorisieren, führen Sie die folgenden Schritte aus:

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator API-Seite. Wenn das Schloss offen ist, haben Sie keine Berechtigung.

   Abbildung 1. Schaltfläche „Autorisieren“.
   

   

   
   

2. Wählen Sie Autorisieren aus. Das Fenster Verfügbare Autorisierungen wird angezeigt.

   Hinweis: Derzeit unterstützen wir ein Autorisierungsschema namens OAuth2.
   Abbildung 2. Verfügbare Berechtigungen
   

   

   
   
3. Alle Scopes sind vorausgewählt, sodass Sie mit allen Endpunkten in der Orchestrator-API experimentieren können. Deaktivieren Sie sie, wenn Sie den Zugriff auf bestimmte APIs einschränken möchten.
4. Wählen Sie Autorisieren aus. Ein neues Fenster wird angezeigt, in dem bestätigt wird, dass Sie autorisiert wurden.
5. Wenn Sie fertig sind, wählen Sie Schließen oder X aus, um das Fenster Verfügbare Autorisierungen zu schließen. Die Schaltfläche „Autorisieren“ zeigt ein geschlossenes Schloss an, das bedeutet, dass Sie autorisiert sind.

Senden von Anforderungen

Während Sie autorisiert sind, können Sie wie folgt Anforderungen an Orchestrator-API-Ressourcen stellen:

1. Erweitern Sie eine Orchestrator-API-Ressource, mit der Sie einen Vorgang ausführen möchten. Das geschlossene Schloss bedeutet, dass Sie autorisiert sind.
   Abbildung 3. Nicht autorisierte API-Ressource
   

   

   
   
2. Wählen Sie im erweiterten Methodenfenster die Option Ausprobieren.
3. Geben Sie bei Bedarf Parameterwerte an.
4. Wählen Sie Ausführen aus. Die Anforderung wird ausgeführt. Für Ihre Anforderungen wird automatisch ein Header der Bearer-Autorisierung verwendet.
   Abbildung 4. Header der Bearer-Autorisierung
   

   

   
   

Generieren eines neuen Zugriffstokens

Wenn das Zugriffstoken abläuft, erhalten Sie eine 401: You are not authenticated! -Antwort. Der Inhaberautorisierungsheader ist immer noch für Ihre Anforderungen vorhanden, aber das Zugriffstoken ist abgelaufen. In diesem Fall müssen Sie das abgelaufene Token für ungültig erklären und ein neues Zugriffstoken generieren:

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator API-Seite. Das Schloss sollte geschlossen werden.
   Abbildung 5. Schaltfläche „Autorisieren“.
   

   

   
   
2. Wählen Sie Autorisieren und auf der angezeigten Seite Verfügbare Autorisierungen die Option Abmelden aus, um das abgelaufene Token zu widerrufen.
   Abbildung 6. Verfügbare Berechtigungen
   

   

   
   
3. Schließen Sie das Fenster Verfügbare Autorisierungen , indem Sie Schließen oder X auswählen, und rufen Sie dann ein Zugriffstoken ab, wie im Abschnitt „Abrufen eines Zugriffstokens“ beschrieben.

Widerrufen von Zugriff

Wenn Sie mit der Arbeit mit der Swagger-UI fertig sind, sollten Sie das von Ihnen verwendete Zugriffstoken für ungültig erklären:

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator API-Seite. Das Schloss sollte geschlossen sein, d. h. Sie sind authorisiert.
2. Klicken Sie auf Autorisieren , und klicken Sie auf der angezeigten Seite Verfügbare Autorisierungen auf Abmelden.
3. Schließen Sie das Fenster Verfügbare Autorisierungen , indem Sie auf Schließen oder Xklicken. Die Schaltfläche Autorisieren zeigt ein offenes Schloss an, was bedeutet, dass Sie nicht autorisiert sind.