- Démarrage
- Authentification
- Swagger definition
- Lisez-moi
- Autorisation des appels d'API dans Swagger
- Managing logical resources
- API Orchestrator
- Demandes d'alertes
- Assets requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- API de gestion de plate-forme

Orchestrator API guide
Autorisation des appels d'API dans Swagger
/swagger/index.html
à l’URL d’Orchestrator. Par exemple, https://{yourDomain}/swagger/index.html
.
L’API qui s’affiche dans Swagger dépend directement de l’instance Orchestrator que vous utilisez. Pour effectuer facilement des requêtes directement depuis Swagger, connectez-vous à Orchestrator dans un autre onglet.
Pour autoriser les appels d’API via l’interface utilisateur Swagger pour les services Orchestrator, effectuez les étapes suivantes :
-
Trouvez le bouton Autoriser en haut à droite de la page API d’Orchestrator. Si le cadenas est ouvert, cela signifie que vous n’êtes pas autorisé.
-
Cliquez sur Autoriser ( Autoriser). La fenêtre Autorisations disponibles s'affiche.
Remarque : nous prenons actuellement en charge un schéma d'autorisation appelé OAuth2. - Toutes les étendues sont présélectionnées de sorte que vous puissiez expérimenter avec tous les points de terminaison dans l'API Orchestrator. Désactivez-les si vous souhaitez restreindre l'accès à certaines API.
- Cliquez sur Autoriser ( Autoriser). Une nouvelle fenêtre s'affiche, confirmant que vous avez été autorisé.
- Une fois cela fait, cliquez sur Fermer ( Close ) ou sur X (X) pour fermer la fenêtre Autorisations disponibles (Available authentications). Le bouton Autoriser (Autorize) affiche un cadenas fermé signifiant que vous êtes autorisé.
Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes sur les ressources de l'API Orchestrator comme suit :
401: You are not authenticated!
. L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton d'accès a expiré. Lorsque cela se produit, vous devez invalider le jeton expiré et générer un nouveau jeton d'accès :
Lorsque vous avez terminé de travailler avec l'interface utilisateur Swagger, vous devez invalider le jeton d'accès que vous avez utilisé :
- Trouvez le bouton Autoriser en haut à droite de la page API d’Orchestrator. Le cadenas devrait être fermé, ce qui signifie que vous êtes autorisé.
- Cliquez sur Autoriser ( Authorize ) et sur la page Autorisations disponibles (Disponibilités ) affichée, cliquez sur Déconnexion ( Logout) .
- Fermez la fenêtre Autorisations disponibles en cliquant sur Fermer ( Close ) ou sur X. Le bouton Autoriser (Authorize) affiche un cadenas ouvert, ce qui signifie que vous n’êtes pas autorisé(e) à vous connecter.