Confluence Cloud-Konfiguration

Auf dieser Seite wird beschrieben, wie Sie Ihre Confluence Cloud-Instanz einrichten und konfigurieren, bevor Sie den Confluence 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 Confluence 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.

Zugriff als Organisationsadministrator in Confluence prüfen

So prüfen Sie den Zugriff als Organisationsadministrator in Confluence:

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

  2. Wählen Sie die Confluence App aus.

  3. Klicken Sie auf Einstellungen.

    Wenn Sie unter Confluence-Einstellungen die Option System sehen, haben Sie Zugriff als Organisationsadministrator. Bitten Sie andernfalls Ihren Confluence-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 auf Create und wählen Sie 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 Anwendung ein.

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

    3. Klicken Sie auf Erstellen.

  5. Führen Sie auf der App-Seite folgende Schritte aus:

    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/confluence_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) folgende 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 als Datenschutzerklärung https://policies.google.com ein.
      3. Wählen Sie für Speichert Ihre App personenbezogene Daten? die Option Ja aus.
      4. Markieren Sie das Kästchen Ich bestätige, dass ich die Personal Data Reporting API implementiert habe.
    4. Klicken Sie auf Änderungen speichern.

  3. Führen Sie auf der App-Seite folgende Schritte aus:

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

Instanz-ID und Instanz‑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 Anwendung.
    3. Suchen Sie die Instanz-URL (die Subdomain in der Adressleiste).

Administratorrollen gewähren

So weisen Sie dem Confluence-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 Confluence 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 bei Atlassian mit einem Organisationsadministrator-Konto 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 Verwaltung auf das Produkt und wählen Sie die Schaltfläche Nutzer verwalten aus.

  4. Klicken Sie unter Nutzerverwaltung auf Gruppen.

  5. Auf der Seite Gruppen:

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

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 Administrator für Nutzerzugriff als Rolle für Confluence aus.

  3. Wählen Sie Produktadministrator als Rolle für die Confluence-Verwaltung aus.

  4. Klicken Sie auf Zugriff gewähren.

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

Mindestbereiche für Anwendungen konfigurieren

So konfigurieren Sie OAuth 2.0 und rufen die erforderlichen Anmeldedaten für die Einrichtung Ihres Confluence-Connectors ab:

  1. OAuth 2.0 aktivieren:
    1. Klicken Sie auf Berechtigungen.
    2. Rufen Sie die Confluence API auf.
    3. Klicken Sie auf Hinzufügen.
    4. Klicken Sie auf Konfigurieren.
    5. Wechseln Sie zum Tab Detaillierte Bereiche und klicken Sie auf Bereiche bearbeiten.
    6. Wählen Sie die folgenden Bereiche aus.
      • read:attachment:confluence
      • read:configuration:confluence
      • read:content.metadata:confluence
      • read:content-details:confluence
      • read:whiteboard:confluence
      • read:group:confluence
      • read:space:confluence
      • read:user:confluence
      • search:confluence
      • write:page:confluence
      • write:attachment:confluence
    7. Prüfen Sie, ob alle Bereiche ausgewählt sind, und speichern Sie Ihre Änderungen.

API-Token in Confluence einrichten

Wenn Sie ein API-Token für die Authentifizierung verwenden möchten, müssen Sie ein API-Token ohne Bereiche erstellen. Dieser Connector unterstützt keine API-Tokens mit Bereichen.

  1. Melden Sie sich in der Atlassian Console an.
  2. Klicken Sie auf API-Token erstellen.
  3. Geben Sie einen Namen für das API-Token ein.
  4. Wählen Sie ein Ablaufdatum für das API-Token aus. Der Zeitraum für den Ablauf des Tokens liegt zwischen 1 und 365 Tagen.
  5. Klicken Sie auf Erstellen.
  6. Speichern Sie das Token zur späteren Verwendung.

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 Developer Console aus.

  3. Klicken Sie auf das Nutzerprofilsymbol und wählen Sie Konto verwalten aus.

  4. Rufen Sie Profil und Sichtbarkeit auf.

  5. Gehen Sie zu Kontakt und legen Sie Wer kann das sehen? auf Jeder fest.

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

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

  2. Wählen Sie eine Confluence-App 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 Sichtbarkeit der E‑Mail-Adresse des Nutzers die Option Öffentlich aus.

  7. Klicken Sie auf Aktualisieren.

User Identity Accessor für Confluence Cloud installieren und konfigurieren

Wenn Nutzer-E-Mail-Adressen aufgrund von Datenschutzeinstellungen in Confluence Cloud nicht standardmäßig öffentlich zugänglich sind, müssen Sie die App User Identity Accessor for Confluence Cloud installieren, um Nutzer-E-Mail-Adressen sicher abzurufen. Wenn die E-Mail-Adressen der Nutzer bereits öffentlich sichtbar sind, müssen Sie die App möglicherweise nicht installieren. Weitere Informationen zur eingeschränkten E-Mail-Sichtbarkeit finden Sie unter Nutzersichtbarkeit verwalten und Rollen zuweisen.

Rollen und Berechtigungen

Zum Installieren und Konfigurieren der App User Identity Accessor for Confluence Cloud benötigen Sie die entsprechende Administratorrolle und müssen die erforderlichen Berechtigungen auf App-Ebene erteilen.

  • Erforderliche Rolle: Sie müssen ein Confluence Site administrator sein, um die App zu installieren und zu konfigurieren.
  • Berechtigungen auf App-Ebene: Sie müssen die folgenden Berechtigungen bei der App-Installation erteilen:
    • Read Email Address: Ermöglicht der App, Nutzer-E-Mail-Adressen sicher abzurufen, auch wenn die Profilsichtbarkeit eingeschränkt ist.
    • App Storage scope: Ermöglicht der App, Daten auf dem Speichergerät zu lesen und darauf zu schreiben.

„User Identity Accessor“ für Confluence Cloud installieren

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

  1. Rufen Sie die Atlassian Developer Console auf.

  2. Prüfen Sie die Berechtigungen Read Email Address und App Storage scope und klicken Sie auf Anwendung herunterladen.

  3. Wählen Sie in der Liste Wählen Sie eine Website aus, auf der Sie diese App installieren möchten die Confluence-Website aus, auf der Sie die App installieren möchten. In dieser Liste werden nur die Websites angezeigt, für die Sie Administratorzugriff haben.

    Hinweis: Sie müssen Administrator mindestens einer Confluence-Website sein, um die App installieren zu können.

  4. Klicken Sie auf Installieren, um die Installation der App abzuschließen.

User Identity Accessor für Confluence Cloud konfigurieren

Nachdem Sie die App User Identity Accessor for Confluence Cloud installiert haben, konfigurieren Sie einen API-Schlüssel, den Ihr externes System (z. B. Ihr Confluence 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 Confluence Cloud in Confluence Cloud auf:

  1. Klicken Sie in Ihrer 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 Confluence Cloud.
  4. Klicken Sie auf Konfigurieren oder auf den Link, der mit Ihrer App verknüpft ist. Die dedizierte Konfigurationsseite der App wird in Confluence geöffnet.

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, Zahlen und Symbolen enthält.

    • Schlüssel generieren: Klicken Sie auf die Schaltfläche Neuen Schlüssel generieren. Das System generiert und zeigt einen starken, zufälligen Schlüssel im Feld an.

      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.

App-Konfiguration testen

Prüfen Sie, ob die User Identity Accessor for Confluence Cloud App richtig konfiguriert ist. Senden Sie dazu eine Anfrage von Ihrem externen System und prüfen Sie, ob die E-Mail-Adressen der Nutzer erfolgreich 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 Confluence-Website und diese App-Installation angezeigt:
    • Ihr externes System muss diese URL aufrufen, um Nutzer-E-Mail-Adressen anzufordern. Beispiel: https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, wobei YOUR_INSTANCE_ID die Kennung Ihrer Confluence 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 Confluence-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 Confluence 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 Confluence 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 Confluence 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 Confluence Cloud-Webtrigger.

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

Supportangebote sind von Google für die App User Identity Accessor for Confluence Cloud verfügbar, die Wartung und regelmäßige Updates enthalten können, um die App auf dem neuesten Stand zu halten. Wenn Sie Probleme oder Fragen zur App-Funktionalität haben, wenden Sie sich an den Google Cloud Support.