Autorisation des appels d'API dans Swagger

Accéder à Swagger

Si vous utilisez Swagger pour tester notre API, il suffit de vous connecter à Orchestrator dans un onglet distinct.

La définition Swagger de l’API Orchestrator est accessible en ajoutant le suffixe /swagger/ui/index#/ à votre URL Orchestrator. Par exemple, https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/.

Remarque : l'authentification Swagger expire en fonction des paramètres définis dans votre instance d'Orchestrator. Par défaut, il est configuré sur 30 minutes. Vous pouvez le changer en modifiant la valeur du paramètre Auth.Cookie.Expire , dans le fichier Web.config .

Obtention d'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é.

   
   

   

   
   

2. Cliquez sur Autoriser ( Autoriser). La fenêtre Autorisations disponibles s'affiche.

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

   

   
   
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. Cliquez sur Autoriser ( Autoriser). Une nouvelle fenêtre s'affiche, confirmant que vous avez été autorisé.
5. 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é.

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

   

   
   
2. Dans la fenêtre de méthode développée, cliquez sur Essayer(Essayer) .
3. Spécifiez les valeurs des paramètres si nécessaire.
4. Cliquez sur Exécuter. La requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
   
   

   

   
   

Génération d'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é.
   
   

   

   
   
2. Cliquez sur Autoriser ( Authorize ) et sur la page Autorisations disponibles (Disponibilités ) affichée, cliquez sur Déconnexion ( Logout ) pour révoquer le jeton expiré.
   
   

   

   
   
3. Fermez la fenêtre Autorisations disponibles (Available authorizations) en cliquant sur Fermer (Close) ou sur X, puis obtenez un jeton d'accès comme décrit dans la section Obtention d'un jeton d'accès (Obtaining an access token).

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.