Intégration avec Atlassian Jira Cloud - Amazon Quick
Avant de commencerConfiguration de l'Atlassian Developer ConsoleConfigurer l'intégration dans Amazon QuickActions disponiblesGestion et résolution des problèmes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Intégration avec Atlassian Jira Cloud

Utilisez le connecteur d'action Atlassian Jira Cloud pour créer, mettre à jour, rechercher et gérer les problèmes, les projets, les sprints et les utilisateurs de Jira directement dans Amazon Quick via le langage naturel.

La configuration de cette intégration comporte deux étapes. Vous devez d'abord créer une application OAuth 2.0 (3LO) dans l'Atlassian Developer Console et configurer ses autorisations. Ensuite, vous créez l'intégration dans Amazon Quick et vous la connectez à votre application Atlassian. Pour plus d'informations sur les méthodes d'authentification prises en charge par Amazon Quick, consultezMéthodes d’authentification.

Avant de commencer

Assurez-vous de disposer des éléments suivants avant de configurer l'intégration.

Configuration de l'Atlassian Developer Console

Si vous prévoyez d'utiliser l'authentification utilisateur (3LO), créez une application OAuth 2.0 dans l'Atlassian Developer Console avant de configurer Amazon Quick. Effectuez toutes les étapes suivantes avant de passer à la console Amazon Quick.

Si vous prévoyez d'utiliser uniquement l'authentification de service (clé API), vous pouvez ignorer cette section et passer àConfigurer l'intégration dans Amazon Quick.

Pour plus d'informations sur les applications OAuth 2.0 (3LO), consultez la section Applications OAuth 2.0 (3LO) dans la documentation Atlassian destinée aux développeurs.

Création d'une OAuth application 2.0 (3LO)

Amazon Quick utilise une application Atlassian OAuth 2.0 (3LO) pour s'authentifier auprès de votre produit Atlassian Cloud au nom de vos utilisateurs. Créez cette application dans l'Atlassian Developer Console avant de configurer Amazon Quick.

  1. Ouvrez l'Atlassian Developer Console et connectez-vous avec votre compte Atlassian.

  2. Choisissez Create, puis choisissez OAuth 2.0 integration.

  3. Dans Nom, entrez un nom descriptif pour votre intégration, par exempleyour-app-name connector.

  4. Consultez et acceptez les conditions d'utilisation d'Atlassian destinées aux développeurs.

  5. Choisissez Créer.

Configurer les autorisations

Après avoir créé l'application OAuth 2.0, ajoutez les autorisations d'API dont Amazon Quick a besoin pour interagir avec votre produit Atlassian.

  1. Depuis votre application dans l'Atlassian Developer Console, choisissez Permissions dans le menu de navigation de gauche.

  2. Recherchez l'API de votre produit Atlassian (par exemple, l'API Jira ou l'API Confluence) et choisissez Ajouter. Le bouton devient Configurer une fois l'API ajoutée.

  3. Choisissez Configurer. La page Étendue s'ouvre avec les onglets Étendue classique et Étendue granulaire.

  4. Dans l'onglet Étendues classiques, choisissez Modifier les étendues. Sélectionnez les portées classiques requises, puis cliquez sur Enregistrer.

  5. Choisissez l'onglet Étendues granulaires, puis sélectionnez Modifier les étendues. Sélectionnez les étendues granulaires requises, puis cliquez sur Enregistrer.

Pour connaître les étendues spécifiques requises pour votre intégration, consultez la section sur les étendues qui suit.

Configurer les autorisations d'API

Ajoutez les étendues suivantes à votre application OAuth 2.0 pour l'intégration des actions Jira Cloud.

oscilloscopes classiques

Dans l'onglet Étendues classiques, choisissez Modifier les étendues et sélectionnez les étendues suivantes.

Intégration d'actions Jira — scopes classiques
Scope Description
read:jira-work Lisez les données relatives aux projets et aux problèmes Jira, recherchez les problèmes et les objets associés à des problèmes, tels que les pièces jointes et les journaux de travail.
manage:jira-project Créez et modifiez les paramètres du projet et créez de nouveaux objets au niveau du projet (par exemple, des versions et des composants).
manage:jira-configuration Effectuez des actions d'administration Jira (par exemple, créez des projets et des champs personnalisés, consultez les flux de travail, gérez les types de liens de problème).
read:jira-user Affichez les informations utilisateur auxquelles l'utilisateur a accès dans Jira, notamment les noms d'utilisateur, les adresses e-mail et les avatars.
write:jira-work Créez et modifiez des problèmes dans Jira, publiez des commentaires en tant qu'utilisateur, créez des journaux de travail et supprimez des problèmes.
manage:jira-webhook Récupérez, enregistrez, actualisez et supprimez les webhooks Jira déclarés dynamiquement.

Oscopes granulaires

Choisissez l'onglet Étendues granulaires, puis sélectionnez Modifier les étendues. Utilisez la barre de recherche pour trouver les champs d'application ci-dessous. Par exemple, recherchez pour trouver des sprint:jira-software oscilloscopes liés au sprint.

Intégration des actions Jira — portées granulaires
Scope Description
read:board-scope:jira-software Lisez les configurations des cartes.
read:sprint:jira-software Lisez les informations relatives au sprint.
write:sprint:jira-software Créez et modifiez des sprints.
delete:sprint:jira-software Supprimez les sprints.
write:board-scope:jira-software Gérez les configurations des cartes.
read:project:jira Lisez les détails du projet.

Configuration de l’autorisation

Définissez l'URL de rappel afin qu'Atlassian puisse rediriger les utilisateurs vers Amazon Quick après avoir autorisé l'application.

  1. Depuis votre application dans l'Atlassian Developer Console, sélectionnez Autorisation dans le menu de navigation de gauche.

  2. À côté de OAuth 2.0 (3LO), choisissez Ajouter.

  3. Pour Callback URLs, entrezhttps://region.quicksight.aws.amazon.com/sn/oauthcallback. regionRemplacez-le par la AWS région dans laquelle votre instance Amazon Quick est déployée, par exempleus-east-1.

  4. Sélectionnez Enregistrer les modifications.

Enregistrez vos informations d'identification

Avant de quitter l'Atlassian Developer Console, vérifiez que vous disposez des valeurs suivantes. Vous en avez besoin pour la configuration d'Amazon Quick.

  1. Depuis votre application dans l'Atlassian Developer Console, choisissez Paramètres dans le menu de navigation de gauche.

  2. Sous Détails de l'authentification, copiez l'ID client et les valeurs secrètes.

Informations d'identification requises depuis l'Atlassian Developer Console
Value Où le trouver
ID de client Page des paramètres, sous Détails de l'authentification
Secret Page des paramètres, sous Détails de l'authentification

Configurer l'intégration dans Amazon Quick

Après avoir préparé vos informations d'authentification, créez l'intégration dans Amazon Quick.

  1. Dans la console Amazon Quick, choisissez Integrations.

  2. Choisissez l'onglet Actions.

  3. Sous Configurer une nouvelle intégration d'applications pour Actions, recherchez Atlassian Jira Cloud et cliquez sur le bouton Ajouter (plus « + »).

  4. Dans l'assistant de création d'intégration, renseignez les champs suivants :

    • Nom : nom descriptif de votre intégration Jira.

    • Description (facultatif) — Remarques sur la façon dont cette connexion sera utilisée.

    • Type de connexion — Choisissez Réseau public.

  5. Dans Paramètres d'authentification, choisissez votre méthode d'authentification et renseignez les champs obligatoires :

    1. Pour l'authentification utilisateur, configurez les champs suivants :

      • URL de base : URL de votre instance Jira pour les appels d'API. Il ne s'agit pas de l'URL à laquelle les utilisateurs se connectent. Cela ressemble à ce qui suit :https://api.atlassian.com/ex/jira/yourInstanceId. Pour trouver l'ID de votre instance, accédez àhttps://your-domain.atlassian.net/_edge/tenant_info.

      • ID client : ID client depuis la page Paramètres de votre application Atlassian OAuth .

      • Secret client : secret depuis la page des paramètres de votre application Atlassian OAuth .

      • URL du jeton — https://auth.atlassian.com/oauth/token

      • URL d'autorisation — https://auth.atlassian.com/authorize

      • URL de redirection : ce champ est prérempli avec votre URL de rappel Amazon Quick.

    2. Pour l'authentification du service, configurez les champs suivants :

      • Clé d'API : jeton d'API Jira.

      • URL de base : URL de votre instance Jira pour les appels d'API.

      • E-mail : adresse e-mail du compte utilisateur associé.

  6. Choisissez Créer et continuer.

  7. (Facultatif) Sur la page Partager l'intégration, choisissez les utilisateurs avec lesquels partager l'intégration.

Important

Jira Cloud peut renvoyer des réponses de réussite HTTP 200 même lorsque les jetons d'API sont révoqués ou mal configurés. Pour plus d'informations, consultez JRACLOUD-82932. Si votre intégration semble réussir mais que les actions échouent de manière inattendue, vérifiez que votre jeton d'API est valide et qu'il n'a pas été révoqué.

Actions disponibles

Après avoir configuré l'intégration, les actions suivantes sont disponibles.

Actions disponibles dans Jira Cloud
Action Description
Ajouter une pièce jointe Ajoutez une pièce jointe à un problème.
Ajouter un commentaire Ajoutez un nouveau commentaire.
Modifier le statut du problème Modifier le statut de la tâche d'un problème.
Créer un problème Créez un nouveau numéro ou une nouvelle sous-tâche.
Créer un projet Créez un nouveau projet.
Créer un sprint Créez un sprint dans un projet.
Supprimer le commentaire Supprimer le commentaire.
Supprimer le problème Supprimez un problème dans un projet.
Supprimer le projet Supprimer le projet.
Supprimer le sprint Supprimer un sprint dans un projet.
Modifier le problème Modifier le problème.
Trouver des utilisateurs Recherchez un utilisateur Jira.
Obtenez toutes les étiquettes Afficher toutes les étiquettes.
Obtenir tous les utilisateurs Répertoriez tous les utilisateurs de Jira.
Obtenir le contenu des pièces jointes Afficher le contenu d'une pièce jointe.
Obtenir des commentaires Afficher les commentaires relatifs aux problèmes.
Obtenir un problème Afficher les détails d'un problème dans un projet.
Obtenir les types de problèmes pour le projet Afficher les types de problèmes liés aux projets.
Obtenez des priorités Afficher les priorités des problèmes.
Obtenir le projet Afficher les détails du projet.
Obtenez Sprint Afficher les détails d'un sprint dans un projet.
Transférer les problèmes vers le backlog Transférez les problèmes vers le backlog.
Déplacer les problèmes vers Sprint and Rank Assignez un problème à un sprint.
Problèmes de recherche Recherchez des problèmes.
Rechercher des projets Trouvez des projets visibles.
Statuts de recherche Rechercher les statuts des problèmes.
Mettre à jour le commentaire Modifier le commentaire.
Mettre à jour le projet Modifiez le projet.
Mettre à jour Sprint Mettez à jour les détails du sprint.
Note

Les actions que vous pouvez utiliser dépendent des autorisations configurées dans votre instance Jira Cloud et de votre méthode d'authentification.

Gestion et résolution des problèmes

Pour modifier, partager ou supprimer votre intégration, consultezGestion des intégrations existantes.

Problèmes d’authentification

  • Configuration d'application incorrecte : vérifiez que l' OAuth application dans l'Atlassian Developer Console inclut les champs d'application requis et que l'URI de redirection correspond à votre configuration Amazon Quick.

  • Jeton d'API expiré ou révoqué : si vous utilisez l'authentification de service, vérifiez que le jeton d'API n'a pas expiré ou n'a pas été révoqué. En raison d'un comportement connu de Jira Cloud (JRACLOUD-82932), l'intégration peut sembler se connecter correctement même avec des jetons non valides.

  • URL de base incorrecte : l'URL de base pour les appels d'API n'est pas la même que l'URL de connexion à Jira Cloud. Vérifiez que vous utilisez le format d'URL de l'API :https://api.atlassian.com/ex/jira/yourInstanceId. Pour trouver l'ID de votre instance, accédez àhttps://your-domain.atlassian.net/_edge/tenant_info.

Messages d'erreur courants

  • Access denied. You do not have permission to perform this action— L'utilisateur authentifié ne dispose pas des autorisations requises dans Jira Cloud. Contactez votre administrateur Jira Cloud pour vérifier et accorder les autorisations appropriées.

  • OAuth 2.0 authorization failed— Vérifiez que l'ID client, le secret du client et OAuth les étendues sont correctement configurés dans l'Atlassian Developer Console et Amazon Quick.