Jira Cloud-Konfiguration

Öffentliche Vorschau:Die Funktionen für die föderierte Suche und Aktionen sind in der öffentlichen Vorschau verfügbar. Diese Funktion unterliegt den „Pre-GA-Angebotsbedingungen“ im Abschnitt „Allgemeine Dienstbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA‑Funktionen stehen in der vorliegenden Form zur Verfügung und bieten möglicherweise nur eingeschränkten Support. Weitere Informationen finden Sie unter Beschreibungen der Startphase.

Auf dieser Seite wird beschrieben, wie Sie eine Drittanbieterkonfiguration einrichten und konfigurieren, bevor Sie den Jira Cloud-Datenspeicher erstellen.

Authentifizierung und Berechtigungen einrichten

Sie müssen die Authentifizierung und Berechtigungen im Atlassian-Administratorkonto einrichten. Das ist wichtig, damit der Connector auf Daten zugreifen und sie synchronisieren kann. Der Jira Cloud-Connector unterstützt verschiedene Authentifizierungsmethoden wie OAuth-Clientanmeldedaten oder API-Tokens.

OAuth 2.0-App erstellen

Wenn Sie eine OAuth 2.0-App für die Authentifizierung erstellen möchten, müssen Sie die Anwendung in der Atlassian Developer Console einrichten und die erforderliche Client-ID und den erforderlichen Clientschlüssel abrufen.

Administratorzugriff für Jira-Organisation überprüfen

So prüfen Sie den Administratorzugriff für die Jira-Organisation:

1. Melden Sie sich mit Ihren Nutzeranmeldedaten bei Atlassian an.

2. Wählen Sie die Jira-App aus.

3. Klicken Sie auf Einstellungen.

   Wenn Sie unter Jira-Einstellungen die Option System sehen, haben Sie Zugriff als Jira-Organisationsadministrator. Andernfalls bitten Sie Ihren Jira-Organisationsadministrator, Ihnen Zugriff zu gewähren.

OAuth 2.0-App erstellen

So erstellen Sie eine OAuth 2.0-App:

1. Melden Sie sich in der Atlassian Developer Console an.

2. Klicken Sie auf das Profilsymbol und wählen Sie Entwicklerkonsole aus.

3. Klicken Sie auf der Seite Console (Konsole) auf Create (Erstellen) und wählen Sie OAuth 2.0 Integration (OAuth 2.0-Integration) aus.

4. Führen Sie auf der Seite zum Erstellen von Apps die folgenden Schritte aus:

   1. Geben Sie einen Namen für die App ein.

   2. Klicken Sie das Kästchen an, um den Entwicklerbedingungen von Atlassian zuzustimmen.

   3. Klicken Sie auf Erstellen.

5. Gehen Sie auf der App-Seite so vor:

   1. Klicken Sie im Navigationsmenü auf Autorisierung.

   2. Wählen Sie in der Tabelle Autorisierungstyp für OAuth 2.0 (3LO) die Option Hinzufügen aus.

6. Geben Sie im Feld Callback-URL https://vertexaisearch.cloud.google.com/console/oauth/jira_oauth.html ein.

7. Klicken Sie auf Änderungen speichern.

Client-ID und Clientschlüssel abrufen

So rufen Sie Client-ID und Clientschlüssel ab:

1. Klicken Sie auf der App-Seite im Navigationsmenü auf Verteilung.

2. Führen Sie auf der Seite Distribution (Verteilung) die folgenden Schritte aus:

   1. Wählen Sie im Bereich Verteilungssteuerung die Option Bearbeiten aus.
   2. Wählen Sie im Abschnitt Veröffentlichungsstatus die Option Freigabe aus, um andere Felder bearbeiten zu können.
   3. Geben Sie Informationen in die folgenden Pflichtfelder ein:
      1. Geben Sie als Anbieter Google ein.
      2. Geben Sie https://policies.google.com als Datenschutzerklärung ein.
      3. Wählen Sie für Speichert Ihre App personenbezogene Daten? die Option Ja aus.
      4. Klicken Sie das Kästchen Ich bestätige, dass ich die API für Berichte zu personenbezogenen Daten implementiert habe an. Weitere Informationen finden Sie unter Personal Data Reporting API.
   4. Klicken Sie auf Änderungen speichern.

3. Gehen Sie auf der App-Seite so vor:

   1. Klicken Sie im Navigationsmenü auf Einstellungen.
   2. Kopieren Sie auf der Seite „Einstellungen“ Ihre Client-ID und Ihren Clientschlüssel.

Instanz-ID und ‑URL abrufen

1. Instanz-ID abrufen:

   1. Öffnen Sie einen neuen Tab, kopieren Sie die Instanz-URL und hängen Sie /_edge/tenant_info an die Instanz-URL an. Beispiel: https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info.
   2. Rufen Sie den Link auf, um den Wert für cloudId zu finden. Die cloudId ist Ihre Instanz-ID.

2. Instanz-URL abrufen:

   1. Rufen Sie atlassian.net auf und melden Sie sich mit Ihrem Administratorkonto an.
   2. Wählen Sie die App aus, die Sie synchronisieren möchten. Synchronisieren Sie beispielsweise die erste App.
   3. Suchen Sie die Instanz-URL (die Subdomain in der Adressleiste).

Projektschlüssel abrufen

So rufen Sie den Projektschlüssel ab:

1. Melden Sie sich in Ihrem Jira Cloud-Konto an.

2. Wählen Sie im Navigationsmenü die Option Spaces aus.

3. Wählen Sie das Projekt aus, für das Sie die Projekt-ID benötigen.

4. Öffnen Sie ein beliebiges Problem in diesem Projekt und klicken Sie auf  more_horiz Aktionen.

5. Klicken Sie auf XML exportieren und laden Sie die Datei herunter.

6. Öffnen Sie die heruntergeladene XML-Datei und suchen Sie nach dem Tag mit project id. Kopieren Sie den Wert, der mit diesem Tag verknüpft ist, zur späteren Verwendung.

Administratorrollen gewähren

So weisen Sie dem Jira-Administrator in der Google Cloud -Console die Rolle „Discovery Engine-Bearbeiter“ zu:

1. Rufen Sie in der Google Cloud Console die Seite Gemini Enterprise auf.

2. Rufen Sie IAM auf.

   IAM aufrufen

3. Suchen Sie das Nutzerkonto mit Administratorzugriff in Jira und klicken Sie auf das Bearbeiten-Symbol.

4. Weisen Sie dem Administrator die Rolle „Discovery Engine-Bearbeiter“ zu.

So weisen Sie einem Nutzer eine Administratorrolle in Atlassian zu:

1. Melden Sie sich mit einem Administratorkonto der Organisation bei Atlassian an.

2. Klicken Sie auf das Menüsymbol und wählen Sie Ihre Organisation aus. Alternativ können Sie auch admin.atlassian.com aufrufen.

3. Klicken Sie auf der Seite Admin (Verwaltung) auf das Produkt und wählen Sie den Button Manage users (Nutzer verwalten) aus.

   

   Nutzer verwalten

4. Klicken Sie unter User management (Nutzerverwaltung) auf Groups (Gruppen).

5. Auf der Seite Gruppen:

   1. Klicken Sie auf Gruppe erstellen.
   2. Geben Sie einen Namen für die Gruppe ein.

   

   Gruppe erstellen

Diese Gruppe erhält die vom Connector benötigten Berechtigungen. Nutzer, die dieser Gruppe hinzugefügt werden, übernehmen diese Berechtigungen. Der Connector verwendet diese Gruppe zur Authentifizierung und zum Abrufen von Dokumenten.

1. Klicken Sie auf der Gruppenseite auf Produkt hinzufügen.

2. Wählen Sie Nutzerzugriffsadministrator als Rolle für Jira aus.

3. Wählen Sie Product admin (Produktadministrator) als Rolle für Jira administration (Jira-Verwaltung) aus.

   

   Nutzerzugriffsadministrator in Jira

4. Klicken Sie auf Grant Access (Zugriff gewähren).

5. Klicken Sie auf Add group members (Gruppenmitglieder hinzufügen), um ein Nutzerkonto oder Gruppenmitglieder hinzuzufügen, die vom Connector zur Authentifizierung und zum Zugriff auf die erforderlichen Ressourcen verwendet werden.

   

   Gruppenmitglieder hinzufügen

Nutzersichtbarkeit verwalten

So machen Sie die E-Mail-Adresse eines Nutzers für alle im Atlassian-Konto sichtbar:

1. Melden Sie sich in der Atlassian Developer Console an.

2. Klicken Sie auf das Profilsymbol und wählen Sie Entwicklerkonsole aus.

3. Klicken Sie auf das Nutzerprofilsymbol und wählen Sie Manage account (Konto verwalten) aus.

   

   Konto verwalten

4. Rufen Sie Profile and visibility (Profil und Sichtbarkeit) auf.

   

   Profil und Sichtbarkeit

5. Gehen Sie zu Contact (Kontakt) und legen Sie für Who can see this (Wer kann das sehen?) die Option Anyone (Jeder) fest.

   

   Kontakt

So machen Sie die E-Mail-Adresse eines Nutzers für alle in Jira sichtbar:

1. Melden Sie sich mit Ihren Nutzeranmeldedaten bei Atlassian an.

2. Wählen Sie eine Jira-Anwendung aus.

3. Klicken Sie auf Einstellungen > System.

4. Wählen Sie im linken Bereich Allgemeine Konfiguration aus.

5. Klicken Sie auf Einstellungen bearbeiten.

6. Wählen Sie für User email visibility (Sichtbarkeit der E‑Mail-Adresse des Nutzers) die Option Public (Öffentlich) aus.

   

   Sichtbarkeit der E‑Mail-Adresse auswählen

7. Klicken Sie auf Aktualisieren.

Mindestbereiche für Anwendungen konfigurieren

Damit die definierten Aktionen ausgeführt werden können, müssen Sie die folgenden Berechtigungen für den Jira Cloud-Connector auf der Atlassian-Plattform einrichten.

1. Klicken Sie auf der Anwendungsseite auf Berechtigungen.

2. Rufen Sie die Jira API auf und klicken Sie auf Hinzufügen.

   Hinweis :Nachdem Sie die Jira API hinzugefügt haben, kann es einen Moment dauern, bis die Schaltfläche Konfigurieren angezeigt wird. Wenn sie nicht sofort angezeigt wird, aktualisieren Sie die Seite oder warten Sie einige Sekunden.

3. Klicken Sie auf Konfigurieren.

4. Rufen Sie den Tab Klassische Bereiche auf.

5. Klicken Sie auf Bereiche bearbeiten und wählen Sie die klassischen Bereiche gemäß Ihren Anforderungen aus der folgenden Tabelle aus:

   Verbindungsmodus	Berechtigung	Zweck
   Föderierte Suche und Aktionen	read:jira-user, read:jira-work	Erforderlich, um Suchergebnisse und Nutzerdetails in Echtzeit abzurufen und anzuzeigen.
   	write:jira-work	Ermöglicht es dem Assistenten, Arbeitselemente zu ändern (z.B. Problemfelder zu aktualisieren) und Kommentare oder Probleme zu verwalten.
   Nur föderierte Suche	read:jira-user, read:jira-work	Erforderlich, um nach Problemen, Projekten und Nutzerprofilen zu suchen und diese anzusehen.
   Datenaufnahme und ‑aktionen	read:jira-work	Erforderlich für das umfassende Crawlen und Indexieren von Arbeitselementen.
   	write:jira-work	Erforderlich, um Schreibvorgänge (Erstellung, Aktualisierungen, Kommentare) für Arbeitselemente in der aufgenommenen Umgebung auszuführen.
   Datenaufnahme	read:jira-work	Erforderlich, um Jira-Inhalte für die Suche zu crawlen und zu indexieren.

6. Prüfen Sie, ob alle Bereiche ausgewählt sind, und klicken Sie auf Speichern.

7. Rufen Sie den Tab Detaillierte Bereiche auf.

8. Klicken Sie auf Bereiche bearbeiten und wählen Sie die detaillierten Bereiche gemäß Ihren Anforderungen aus der folgenden Tabelle aus:

   Verbindungsmodus	Berechtigung	Zweck
   Föderierte Suche und Aktionen	write:comment:jira	Ermöglicht es dem Assistenten, neue Kommentare oder Antworten direkt über die Suchoberfläche zu posten.
   	write:issue:jira	Erforderlich, um neue Probleme zu erstellen oder größere Änderungen an bestehenden Problemen vorzunehmen.
   Datenaufnahme und ‑aktionen	read:user:jira, read:group:jira, read:avatar:jira	Erforderlich für die Synchronisierung von Nutzer-/Gruppenmetadaten und die Anzeige von Nutzerprofilen.
   	read:issue-security-level:jira, read:issue-security-scheme:jira	Wichtig für die Zugriffssteuerung; sorgt dafür, dass die aufgenommenen Daten die Sicherheitsgrenzen von Jira einhalten.
   	read:audit-log:jira	Wird verwendet, um Änderungen zu verfolgen und inkrementelle Synchronisierungen durchzuführen, damit aufgenommene Daten auf dem neuesten Stand bleiben.
   	write:comment:jira	Erforderlich, um mit dem Assistenten Kommentare zu Problemen hinzuzufügen.
   	write:issue:jira	Ermöglicht das Erstellen oder Ändern von Problemen.
   Datenaufnahme	read:user:jira, read:group:jira, read:avatar:jira	Erforderlich, um Jira-Inhalte und Nutzerbeziehungen zu crawlen und zu indexieren.
   	read:issue-security-level:jira, read:issue-security-scheme:jira	Erforderlich, um Berechtigungen zuzuordnen, damit nur autorisierte Nutzer die aufgenommenen Daten durchsuchen können.
   	read:audit-log:jira	Erforderlich, damit die Synchronisierungs-Engine erkennen kann, welche Elemente aktualisiert oder gelöscht wurden.

9. Prüfen Sie, ob alle Bereiche ausgewählt sind, und klicken Sie auf Speichern.

Hinweis :Wenn Sie Aktionen überspringen und den Datenspeicher für die Suche verwenden möchten, können Sie die Berechtigungen auf read-Berechtigungen beschränken. write-Berechtigungen sind nur erforderlich, um die unter Unterstützte Aktionen aufgeführten Aktionen auszuführen.

„User Identity Accessor“ installieren

So installieren Sie die App User Identity Accessor for Jira Cloud auf Ihrer Jira Cloud-Website:

1. Rufen Sie den Atlassian Marketplace auf.

2. Klicken Sie auf Jetzt holen.

   

   Jetzt herunterladen

3. Wählen Sie in der Liste Website auswählen die Jira-Website aus, auf der Sie die App installieren möchten.

   Hinweis :Sie benötigen Administratorberechtigungen für die ausgewählte Jira-Website, um die App installieren zu können.

4. Klicken Sie auf Überprüfen, um die erforderlichen Berechtigungen zu autorisieren und den Nutzungsbedingungen zuzustimmen.

5. Klicken Sie auf Jetzt herunterladen, um die Installation der App abzuschließen.

   Nach der erfolgreichen Installation wird eine Bestätigungsmeldung angezeigt: „Ihre App wurde Ihrer Instanz hinzugefügt und kann verwendet werden.“

User Identity Accessor konfigurieren

Nachdem Sie die App User Identity Accessor for Jira Cloud installiert haben, konfigurieren Sie einen API-Schlüssel, den Ihr externes System (z. B. Ihr Jira Cloud Connector) verwendet, um den Webtrigger der App sicher aufzurufen und E-Mail-Adressen abzurufen.

Konfigurationsseite aufrufen

So rufen Sie die Konfigurationsseite der App User Identity Accessor for Jira Cloud auf:

1. Klicken Sie in Ihrer Jira Cloud-Instanz im Navigationsmenü auf das Symbol Einstellungen ⚙️.
2. Wählen Sie im Menü Apps aus.
3. Suchen Sie auf der Seite App-Verwaltung in der Liste Apps verwalten nach der App User Identity Accessor for Jira Cloud.

4. Klicken Sie auf Configure (Konfigurieren) oder auf den Link, der mit Ihrer Anwendung verknüpft ist. Die dedizierte Konfigurationsseite der Anwendung wird in Jira Cloud geöffnet.

   

   Anwendung „User Identity Accessor for Jira Cloud“ konfigurieren

API-Schlüssel einrichten

So richten Sie den API-Schlüssel auf der Konfigurationsseite ein:

1. Geben Sie im Abschnitt API-Schlüsselkonfiguration den geheimen Schlüssel für die Authentifizierung von Anfragen an den Webtrigger der App an. Sie können Anfragen mit beiden der folgenden Methoden authentifizieren:

   • Eigenen Schlüssel eingeben: Geben Sie Ihren eigenen starken, eindeutigen API-Schlüssel in das Feld API-Schlüssel ein oder fügen Sie ihn dort ein. Verwenden Sie einen Schlüssel mit mindestens 20 bis 30 Zeichen, der eine Kombination aus Großbuchstaben, Kleinbuchstaben, Ziffern und Symbolen enthält.

     

     Eigenen Schlüssel eingeben

   • Schlüssel generieren: Klicken Sie auf den Button Generate New Key (Neuen Schlüssel generieren). Das System generiert einen starken, zufälligen Schlüssel und zeigt ihn im Feld an.

     

     Schlüssel generieren

     Wichtig: Kopieren Sie den im Feld angezeigten API-Schlüssel sofort. Aus Sicherheitsgründen kann es sein, dass Sie den vollständigen Schlüssel nach dem Speichern oder Verlassen der Seite nicht mehr sehen können. Wenn Sie ihn verlieren, müssen Sie einen neuen festlegen oder generieren.

2. Klicken Sie auf API-Schlüssel speichern. Eine Erfolgsmeldung bestätigt, dass der Schlüssel sicher gespeichert wurde.

Hinweis: Der in diesem Abschnitt generierte oder erstellte API-Schlüssel dient als Wert für das Feld Jira Identity Sync Forge Client Secret im Abschnitt Erweiterte Optionen während der Connector-Einrichtung.

App-Konfiguration testen

Prüfen Sie, ob die App User Identity Accessor for Jira Cloud richtig konfiguriert ist. Senden Sie dazu eine Anfrage von Ihrem externen System und prüfen Sie, ob die E-Mail-Adressen der Nutzer zurückgegeben werden.

Webtrigger-URL abrufen

1. Suchen Sie auf der Seite App-Verwaltung nach dem Abschnitt Webtrigger-URL Dort wird die eindeutige URL für Ihre Jira-Website und diese App-Installation angezeigt:
   • Ihr externes System muss diese URL aufrufen, um Nutzer-E-Mail-Adressen anzufordern.
   • Beispiel-URL: https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, wobei YOUR_INSTANCE_ID die Kennung Ihrer Jira Cloud-Instanz und WEBTRIGGER_ID die eindeutige Kennung für den für Ihre App generierten Webtrigger-Endpunkt ist.
2. Klicken Sie auf die Schaltfläche URL kopieren oder kopieren Sie die gesamte URL.

Externes System konfigurieren

• Konfigurieren Sie Ihr externes System, das Jira-Nutzer-E-Mail-Adressen mit dem API-Schlüssel und der Webtrigger-URL abrufen muss, die Sie in den vorherigen Schritten erhalten haben.

• Endpunkt-URL: Die Webtrigger-URL, die Sie kopiert haben.

• HTTP-Methode: POST

• Erforderliche Header:

  • Inhaltstyp: application/json

  • X-Api-Key: YOUR_API_KEY

    Ersetzen Sie YOUR_API_KEY durch den API-Schlüssel, den Sie im Abschnitt API-Schlüssel einrichten festgelegt oder generiert haben.

Beispiel: cURL-Befehls

In diesem Beispiel wird der Webtrigger User Identity Accessor for Jira Cloud aufgerufen, der ein Array von Konto-IDs akzeptiert und die E-Mail-Adressen zurückgibt.

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

Ersetzen Sie:

• YOUR_INSTANCE_ID durch Ihre Jira Cloud-Instanz-ID
• ENDPOINT_PATH durch den API-Endpunktpfad
• YOUR_API_KEY durch den API-Schlüssel, den Sie im Abschnitt API-Schlüssel einrichten festgelegt oder generiert haben
• ACCOUNT_ID durch die Atlassian-Konto-IDs, die Sie als Zielgruppe verwenden möchten

Erwartete Antwort

[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

Ersetzen Sie:

• ACCOUNT_ID_X durch tatsächliche Atlassian-Konto-IDs
• USER_EMAIL_X durch Nutzer-E-Mail-Adressen, die von Ihrem API-Aufruf zurückgegeben werden

Best Practices für die Sicherheit implementieren

Folgen Sie diesen Empfehlungen, um die Sicherheit Ihres API-Schlüssels zu bestätigen:

• Speichern Sie den API-Schlüssel sicher in der Konfiguration Ihres Jira Cloud-Connectors.
• Prüfen Sie, ob die gesamte Kommunikation mit der Webhook-URL über HTTPS erfolgt. Dies ist die Standardeinstellung für User Identity Accessor for Jira Cloud-Webtrigger.

Unterstützung für User Identity Accessor für Jira Cloud

Google bietet Support für die App User Identity Accessor for Jira Cloud an, der Wartung und regelmäßige Updates umfasst, damit die App immer auf dem neuesten Stand ist. Wenn Sie Probleme oder Fragen zur App-Funktionalität haben, wenden Sie sich an den Google Cloud Support. Weitere Informationen finden Sie unter Cloud Customer Care erhalten.