Atlassian Jira Cloud-Integration - Amazon Quick
Bevor Sie beginnenKonfiguriere die Atlassian Developer ConsoleRichten Sie die Integration in Amazon Quick einVerfügbare AktionenVerwaltung und Fehlerbehebung

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Atlassian Jira Cloud-Integration

Verwende den Atlassian Jira Cloud Action Connector, um Jira-Probleme, Projekte, Sprints und Benutzer direkt in Amazon Quick in natürlicher Sprache zu erstellen, zu aktualisieren, zu suchen und zu verwalten.

Die Einrichtung dieser Integration umfasst zwei Schritte. Zunächst erstellst du eine App OAuth 2.0 (3LO) in der Atlassian Developer Console und konfigurierst deren Berechtigungen. Anschließend erstellst du die Integration in Amazon Quick und verbindest sie mit deiner Atlassian-App. Informationen zu den Authentifizierungsmethoden, die Amazon Quick unterstützt, finden Sie unterAuthentifizierungsmethoden.

Bevor Sie beginnen

Stellen Sie sicher, dass Sie über Folgendes verfügen, bevor Sie die Integration einrichten.

Konfiguriere die Atlassian Developer Console

Wenn du die Benutzerauthentifizierung (3LO) verwenden möchtest, erstelle eine OAuth 2.0-App in der Atlassian Developer Console, bevor du Amazon Quick konfigurierst. Führen Sie alle folgenden Schritte aus, bevor Sie zur Amazon Quick-Konsole wechseln.

Wenn Sie nur die Serviceauthentifizierung (API-Schlüssel) verwenden möchten, können Sie diesen Abschnitt überspringen und mit dem nächsten Schritt fortfahrenRichten Sie die Integration in Amazon Quick ein.

Weitere Informationen zu OAuth 2.0 (3LO) -Apps findest du unter OAuth 2.0 (3LO) -Apps in der Atlassian-Entwicklerdokumentation.

Erstelle eine OAuth 2.0 (3LO) -App

Amazon Quick verwendet eine Atlassian OAuth 2.0 (3LO) -App, um sich im Namen deiner Nutzer bei deinem Atlassian Cloud-Produkt zu authentifizieren. Erstelle diese App in der Atlassian Developer Console, bevor du Amazon Quick konfigurierst.

  1. Öffne die Atlassian Developer Console und melde dich mit deinem Atlassian-Konto an.

  2. Wähle „Erstellen“ und dann „2.0-Integration“. OAuth

  3. Geben Sie unter Name beispielsweise your-app-name connector einen aussagekräftigen Namen für Ihre Integration ein.

  4. Lies dir die Nutzungsbedingungen von Atlassian für Entwickler durch und akzeptiere sie.

  5. Wählen Sie Erstellen aus.

Konfigurieren von -Berechtigungen

Nachdem du die OAuth 2.0-App erstellt hast, füge die API-Berechtigungen hinzu, die Amazon Quick für die Interaktion mit deinem Atlassian-Produkt benötigt.

  1. Wähle in deiner App in der Atlassian Developer Console im linken Navigationsbereich die Option Berechtigungen aus.

  2. Finde die API für dein Atlassian-Produkt (zum Beispiel Jira API oder Confluence API) und wähle Hinzufügen. Die Schaltfläche ändert sich zu Konfigurieren, nachdem die API hinzugefügt wurde.

  3. Wählen Sie Konfigurieren aus. Die Seite „Bereiche“ wird mit den Registerkarten „Klassische Bereiche“ und „Granulare Bereiche“ geöffnet.

  4. Wählen Sie auf der Registerkarte Klassische Bereiche die Option Bereiche bearbeiten aus. Wählen Sie die erforderlichen klassischen Bereiche aus und klicken Sie auf Speichern.

  5. Wählen Sie die Registerkarte Granular Scopes und anschließend Edit Scopes aus. Wählen Sie die erforderlichen detaillierten Bereiche aus und klicken Sie auf Speichern.

Die spezifischen Bereiche, die für Ihre Integration erforderlich sind, finden Sie im folgenden Abschnitt Bereiche.

Konfigurieren Sie API-Berechtigungen

Fügen Sie Ihrer OAuth 2.0-App die folgenden Bereiche für die Jira Cloud-Aktionsintegration hinzu.

Klassische Bereiche

Wählen Sie auf der Registerkarte Klassische Bereiche die Option Bereiche bearbeiten und wählen Sie die folgenden Bereiche aus.

Jira-Aktionsintegration — klassische Bereiche
Scope Description
read:jira-work Lesen Sie Jira-Projekt- und Problemdaten, suchen Sie nach Problemen und Objekten, die mit Problemen verknüpft sind, wie Anhängen und Worklogs.
manage:jira-project Erstellen und bearbeiten Sie Projekteinstellungen und erstellen Sie neue Objekte auf Projektebene (z. B. Versionen und Komponenten).
manage:jira-configuration Ergreifen Sie Jira-Verwaltungsmaßnahmen (z. B. Projekte und benutzerdefinierte Felder erstellen, Workflows anzeigen, Problemlinktypen verwalten).
read:jira-user Zeigen Sie Benutzerinformationen in Jira an, auf die der Benutzer Zugriff hat, einschließlich Benutzernamen, E-Mail-Adressen und Avatare.
write:jira-work Erstellen und bearbeiten Sie Probleme in Jira, posten Sie Kommentare als Benutzer, erstellen Sie Arbeitsprotokolle und löschen Sie Probleme.
manage:jira-webhook Dynamisch deklarierte Jira-Webhooks abrufen, registrieren, aktualisieren und löschen.

Granularer Geltungsbereich

Wählen Sie die Registerkarte Granular Scopes und anschließend Edit Scopes aus. Verwenden Sie die Suchleiste, um die unten aufgeführten Bereiche zu finden. Suchen Sie beispielsweise nach Zielfernrohren, sprint:jira-software um Bereiche zu finden, die sich auf Sprints beziehen.

Jira-Aktionsintegration — detaillierte Anwendungsbereiche
Scope Description
read:board-scope:jira-software Lesen Sie die Board-Konfigurationen.
read:sprint:jira-software Lesen Sie die Sprint-Informationen.
write:sprint:jira-software Sprints erstellen und ändern.
delete:sprint:jira-software Sprints löschen.
write:board-scope:jira-software Verwalte die Board-Konfigurationen.
read:project:jira Lesen Sie die Projektdetails.

Autorisierung konfigurieren

Lege die Callback-URL so fest, dass Atlassian Benutzer zurück zu Amazon Quick weiterleiten kann, nachdem sie die App autorisiert haben.

  1. Wähle in deiner App in der Atlassian Developer Console im linken Navigationsbereich die Option Autorisierung aus.

  2. Wähle neben OAuth 2.0 (3LO) die Option Hinzufügen aus.

  3. Geben Sie für Callback den Wert URLs ein. https://region.quicksight.aws.amazon.com/sn/oauthcallback regionErsetzen Sie es beispielsweise durch die AWS Region, in der Ihre Amazon Quick-Instance bereitgestellt wirdus-east-1.

  4. Wählen Sie Änderungen speichern aus.

Notieren Sie sich Ihre Anmeldedaten

Bevor du die Atlassian Developer Console verlässt, vergewissere dich, dass du die folgenden Werte hast. Sie benötigen sie für die Amazon Quick-Konfiguration.

  1. Wähle in deiner App in der Atlassian Developer Console im linken Navigationsbereich Einstellungen aus.

  2. Kopiere unter Authentifizierungsdetails die Werte Client-ID und Secret.

Erforderliche Anmeldedaten aus der Atlassian Developer Console
Wert Wo ist es zu finden
Client-ID Seite mit den Einstellungen unter Authentifizierungsdetails
Secret Seite mit den Einstellungen unter Authentifizierungsdetails

Richten Sie die Integration in Amazon Quick ein

Nachdem Sie Ihre Authentifizierungsdaten vorbereitet haben, erstellen Sie die Integration in Amazon Quick.

  1. Wählen Sie in der Amazon Quick-Konsole Integrationen aus.

  2. Wählen Sie den Tab Aktionen.

  3. Suche unter Neue App-Integration für Aktionen einrichten nach Atlassian Jira Cloud und wähle die Schaltfläche Hinzufügen (plus „+“).

  4. Fülle im Assistenten „Integration erstellen“ die folgenden Felder aus:

    • Name — Beschreibender Name für Ihre Jira-Integration.

    • Beschreibung (optional) — Hinweise dazu, wie diese Verbindung verwendet wird.

    • Verbindungstyp — Wählen Sie Öffentliches Netzwerk.

  5. Wählen Sie unter Authentifizierungseinstellungen Ihre Authentifizierungsmethode und füllen Sie die erforderlichen Felder aus:

    1. Konfigurieren Sie für die Benutzerauthentifizierung die folgenden Felder:

      • Basis-URL — Ihre Jira-Instanz-URL für API-Aufrufe. Dies ist nicht dieselbe URL, mit der sich Benutzer anmelden. Es ähnelt dem Folgenden:https://api.atlassian.com/ex/jira/yourInstanceId. Um Ihre Instance-ID zu finden, navigieren Sie zuhttps://your-domain.atlassian.net/_edge/tenant_info.

      • Client-ID — Die Client-ID findest du auf der Einstellungsseite deiner Atlassian-App OAuth .

      • Kundengeheimnis — Geheim aus der Einstellungsseite deiner OAuth Atlassian-App.

      • Token-URL — https://auth.atlassian.com/oauth/token

      • Autorisierungs-URL — https://auth.atlassian.com/authorize

      • Weiterleitungs-URL — Dieses Feld ist bereits mit Ihrer Amazon Quick Callback-URL gefüllt.

    2. Konfigurieren Sie für die Serviceauthentifizierung die folgenden Felder:

      • API-Schlüssel — Jira-API-Token.

      • Basis-URL — Ihre Jira-Instanz-URL für API-Aufrufe.

      • E-Mail — E-Mail-Adresse des zugehörigen Benutzerkontos.

  6. Wählen Sie Erstellen und fortfahren.

  7. (Optional) Wählen Sie auf der Seite „Integration teilen“ die Benutzer aus, mit denen Sie die Integration teilen möchten.

Wichtig

Jira Cloud gibt möglicherweise HTTP 200-Erfolgsantworten zurück, selbst wenn API-Token gesperrt oder falsch konfiguriert wurden. Weitere Informationen finden Sie unter JRACLOUD-82932. Wenn Ihre Integration anscheinend erfolgreich eine Verbindung herstellt, Aktionen jedoch unerwartet fehlschlagen, überprüfen Sie, ob Ihr API-Token gültig ist und nicht gesperrt wurde.

Verfügbare Aktionen

Nachdem Sie die Integration eingerichtet haben, sind die folgenden Aktionen verfügbar.

Verfügbare Aktionen in Jira Cloud
Action Description
Anlage hinzufügen Einen Anhang zu einer Ausgabe hinzufügen.
Kommentar hinzufügen Neuen Kommentar hinzufügen.
Problemstatus ändern Ändern Sie den Aufgabenstatus eines Problems.
Problem erstellen Neues Problem oder Unteraufgabe erstellen.
Projekt erstellen Neues Projekt erstellen.
Sprint erstellen Erstellen Sie einen Sprint in einem Projekt.
Kommentar löschen Kommentar entfernen.
Problem löschen Löscht ein Problem in einem Projekt.
Löschen eines Projekts Projekt entfernen.
Sprint löschen Löschen Sie einen Sprint in einem Projekt.
Problem bearbeiten Problem ändern.
Benutzer finden Suchen Sie nach einem Jira-Benutzer.
Alle Labels abrufen Alle Labels anzeigen.
Alle Benutzer abrufen Listet alle Jira-Benutzer auf.
Inhalt von Anhängen abrufen Den Inhalt eines Anhangs anzeigen.
Kommentare abrufen Kommentare zum Problem anzeigen.
Problem abrufen Details zu einem Problem in einem Projekt anzeigen.
Problemtypen für das Projekt abrufen Problemtypen für Projekte anzeigen.
Prioritäten abrufen Prioritäten der Probleme anzeigen.
Holen Sie sich das Projekt Projektdetails anzeigen.
Holen Sie sich Sprint Details eines Sprints in einem Projekt anzeigen.
Probleme in den Backlog verschieben Probleme in den Backlog verschieben.
Probleme nach Sprint und Rang verschieben Ordnen Sie einem Sprint ein Problem zu.
Probleme suchen Suchen Sie nach Problemen.
Projekte suchen Finde sichtbare Projekte.
Status durchsuchen Suchen Sie nach dem Status von Problemen.
Kommentar aktualisieren Kommentar bearbeiten.
Projekt aktualisieren Projekt ändern.
Sprint aktualisieren Sprint-Details aktualisieren.
Anmerkung

Die Aktionen, die Sie verwenden können, hängen von den in Ihrer Jira Cloud-Instanz konfigurierten Berechtigungen und Ihrer Authentifizierungsmethode ab.

Verwaltung und Fehlerbehebung

Informationen zum Bearbeiten, Teilen oder Löschen Ihrer Integration finden Sie unterVerwaltung vorhandener Integrationen.

Probleme bei der Authentifizierung

  • Falsche App-Konfiguration — Stelle sicher, dass die OAuth App in der Atlassian Developer Console die erforderlichen Bereiche umfasst und dass die Umleitungs-URI mit deiner Amazon Quick-Konfiguration übereinstimmt.

  • Abgelaufenes oder widerrufenes API-Token — Wenn du die Serviceauthentifizierung verwendest, überprüfe, ob das API-Token nicht abgelaufen ist oder gesperrt wurde. Aufgrund eines bekannten Verhaltens von Jira Cloud (JRACLOUD-82932) scheint die Integration auch bei ungültigen Tokens erfolgreich eine Verbindung herzustellen.

  • Falsche Basis-URL — Die Basis-URL für API-Aufrufe ist nicht identisch mit der Jira Cloud-Anmelde-URL. Stellen Sie sicher, dass Sie das API-URL-Format verwenden:https://api.atlassian.com/ex/jira/yourInstanceId. Um Ihre Instanz-ID zu finden, navigieren Sie zuhttps://your-domain.atlassian.net/_edge/tenant_info.

Häufige Fehlermeldungen

  • Access denied. You do not have permission to perform this action— Der authentifizierte Benutzer verfügt nicht über die erforderlichen Berechtigungen in Jira Cloud. Wenden Sie sich an Ihren Jira Cloud-Administrator, um die entsprechenden Berechtigungen zu überprüfen und zu erteilen.

  • OAuth 2.0 authorization failed— Stelle sicher, dass die Client-ID, der geheime Schlüssel und die OAuth Bereiche sowohl in der Atlassian Developer Console als auch in Amazon Quick korrekt konfiguriert sind.