API REST¶

Les administrateurs créent des jetons Bearer avec des scopes définis pour les applications externes.

Vue d’ensemble¶

Cette page décrit l’utilisation et les principaux effets de API REST. Si les modifications influencent des tickets, autorisations, notifications ou automatisations existants, elles doivent d’abord être vérifiées dans un environnement de test.

Flux de travail typique¶

Rechercher un utilisateur pour un jeton. Utilisez les vues de recherche, de filtre et de détail disponibles. Effacez ou modifiez les filtres si les enregistrements attendus n’apparaissent pas.
Créer un jeton avec un nom et des scopes. Ouvrez le formulaire de gestion ou d’action correspondant, saisissez les valeurs requises et n’enregistrez qu’après avoir vérifié les affectations et les champs obligatoires.
Récupérer la valeur du jeton en toute sécurité. Exécutez la fonction dans le formulaire prévu et contrôlez immédiatement le résultat dans la vue correspondante ou sur le ticket concerné.
Désactiver le jeton. Vérifiez d’abord quels enregistrements ou utilisateurs existants sont concernés. Dans la mesure du possible, préférez la désactivation à la suppression définitive.
Comprendre la journalisation des requêtes et l’idempotence. Exécutez la fonction dans le formulaire prévu et contrôlez immédiatement le résultat dans la vue correspondante ou sur le ticket concerné.
Ouvrir la description OpenAPI. Exécutez la fonction dans le formulaire prévu et contrôlez immédiatement le résultat dans la vue correspondante ou sur le ticket concerné.

Remarques¶

Les éléments de menu et les actions visibles dépendent des autorisations de groupe et de programme de l’agent connecté.
Les entrées désactivées restent souvent disponibles pour les tickets et évaluations existants, mais ne peuvent plus être utilisées pour de nouvelles affectations.
Après toute modification, testez au moins un cas d’utilisation réaliste avec un utilisateur du rôle concerné.