- Erste Schritte
- Authentication
- Swagger-Definition
- Hier lesen
- Autorisieren von API-Aufrufen in Swagger
- Verwalten logischer Ressourcen
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Generische Aufgabenanforderungen
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Prozessabfragen
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
- Plattformverwaltungs-APIs
Autorisieren von API-Aufrufen in Swagger
Wenn Sie Ihre API mit Swagger ausprobieren, brauchen Sie sich nur auf einer separaten Registerkarte bei Orchestrator anzumelden.
/swagger/ui/index#/
zu Ihrer Orchestrator-URL hinzufügen. Zum Beispiel: https://{IhreDomäne} /swagger/ui/index#/
.
Auth.Cookie.Expire
in Datei Web.config
ändern.
Um API-Aufrufe über die Swagger-Benutzeroberfläche für Orchestrator-Dienste zu autorisieren, führen Sie die folgenden Schritte aus:
-
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.
-
Klicken Sie auf Autorisieren. Das Fenster Verfügbare Autorisierungen wird angezeigt.
Hinweis: Derzeit unterstützen wir ein Autorisierungsschema namens OAuth2. - 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.
- Klicken Sie auf Autorisieren. Ein neues Fenster wird angezeigt, in dem bestätigt wird, dass Sie autorisiert wurden.
- Klicken Sie anschließend auf Schließen oder X , um das Fenster Verfügbare Autorisierungen zu schließen. Die Schaltfläche Autorisieren zeigt ein geschlossenes Schloss an, was bedeutet, dass Sie autorisiert sind.
Während Sie autorisiert sind, können Sie wie folgt Anforderungen an Orchestrator-API-Ressourcen stellen:
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:
Wenn Sie mit der Arbeit mit der Swagger-UI fertig sind, sollten Sie das von Ihnen verwendete Zugriffstoken für ungültig erklären:
- 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.
- Klicken Sie auf Autorisieren , und klicken Sie auf der angezeigten Seite Verfügbare Autorisierungen auf Abmelden.
- 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.