Autorisation des appels d'API dans Swagger

Accéder à Swagger

Pour accéder à l’API Swagger d’Orchestrator, ajoutez /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.

Obtenir un jeton d’accès

Pour autoriser les appels d’API via l’interface utilisateur Swagger pour les services Orchestrator, effectuez les étapes suivantes :

1. 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é.

   Figure 1. Authorize button
   

   

   
   

2. Select Authorize. The Available authorizations window is displayed.

   Remarque : nous prenons actuellement en charge un schéma d'autorisation appelé OAuth2.
   Figure 2. Available authorizations
   

   

   
   
3. 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.
4. Select Authorize. A new window is displayed confirming you have been authorized.
5. Once done, select Close or X to close the Available authorizations window. The Authorize button shows an closed lock meaning you are authorized.

Envoi de requêtes

Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes sur les ressources de l'API Orchestrator comme suit :

1. Développez une ressource d'API Orchestrator avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
   Figure 3. Unauthorized API resource
   

   

   
   
2. In the expanded method window, select Try it out.
3. Spécifiez les valeurs des paramètres si nécessaire.
4. Select Execute. The request is executed. A bearer authorization header is automatically used for your requests.
   Figure 4. Bearer authorization header
   

   

   
   

Générer un nouveau jeton d’accès

Lorsque le jeton d'accès expire, vous recevez une réponse 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 :

1. Trouvez le bouton Autoriser en haut à droite de la page API d’Orchestrator. Le cadenas devrait être fermé.
   Figure 5. Authorize button
   

   

   
   
2. Select Authorize and on the displayed Available authorizations page, select Logout to revoke the expired token.
   Figure 6. Available authorizations
   

   

   
   
3. Close the Available authorizations window by selecting Close or X and then obtain an access token as described on the Obtaining an access token section.

Révoquer l’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é :

1. 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é.
2. Cliquez sur Autoriser ( Authorize ) et sur la page Autorisations disponibles (Disponibilités ) affichée, cliquez sur Déconnexion ( Logout) .
3. 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.