Orchestrator
2023.10
False
- Démarrage
- Lisez-moi
- À propos d'OData et des références
- URL d'Orchestrator
- Références d'API
- Ressources logiques et métadonnées
- Opérations disponibles
- Fichiers énumérés (Enumerated Files)
- Authentification
- Création des requêtes d'API
- Applications externes (OAuth)
- Autorisations par point de terminaison
- Codes de réponse
- Points de terminaison de vérification de l'état
- Définition Swagger
- Autorisation des appels d'API dans Swagger
- Gestion des ressources logiques
- Exemples d'utilisation de l'API Orchestrator
- Demandes d'alertes
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches génériques
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes d'espaces de travail personnels
- Requêtes relatives aux processus
- Demandes d'éléments de la file d'attente
- Requêtes en matière de stratégie de rétention des files d’attente
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de compartiments de stockage
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
- API de gestion de plate-forme
Autorisation des appels d'API dans Swagger
Guide de l'API Orchestrator
Dernière mise à jour 10 nov. 2023
Autorisation des appels d'API dans Swagger
Pour autoriser les appels d'API via l'interface utilisateur Swagger pour les services Orchestrator dans Automation Cloud pour le secteur public, effectuez les étapes suivantes :
-
Recherchez le bouton Autoriser (Authorize) dans le coin supérieur droit de la page API d'Orchestrator (
{organization_name}/{tenant_name}/orchestrator_/swagger
). Si le cadenas est ouvert, vous n'êtes pas autorisé(e). -
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 :
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 :
Lorsque vous avez terminé de travailler avec l'interface utilisateur Swagger, vous devez invalider le jeton d'accès que vous avez utilisé :
- Recherchez le bouton Autoriser (Authorize) dans le coin supérieur droit de la page API d'Orchestrator (
{organization_name}/{tenant_name}/orchestrator_/swagger
). Le cadenas doit être fermé, ce qui signifie que vous y ê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.