View a markdown version of this page

Aktionsintegration in Atlassian Confluence Cloud - Amazon Quick
Bevor Sie beginnenKonfiguriere die Atlassian Developer ConsoleBereiten Sie die Authentifizierung vorRichten Sie die Integration in Amazon Quick einVerfügbare AktionenVerwaltung und Problembehebung

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.

Aktionsintegration in Atlassian Confluence Cloud

Verwende den Action-Connector von Atlassian Confluence Cloud, um Confluence-Seiten und -Bereiche direkt in Amazon Quick in natürlicher Sprache zu erstellen, zu aktualisieren und zu verwalten.

Um diese Integration einzurichten, erstellst du zunächst 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 fortfahrenBereiten Sie die Authentifizierung vor.

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 Permissions 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.

Informationen zu den spezifischen Bereichen, die für Ihre Integration erforderlich sind, finden Sie im folgenden Abschnitt Bereiche.

Erforderliche Bereiche für Confluence

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

Klassischer Geltungsbereich

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

Confluence-Aktionsintegration — klassischer Geltungsbereich
Scope Description
search:confluence Suchen Sie nach Confluence-Inhalten und Space-Zusammenfassungen.

Detaillierte Anwendungsbereiche

Wählen Sie die Registerkarte Granular Scopes und anschließend Edit Scopes aus. Wählen Sie die folgenden Bereiche aus.

Integration von Confluence-Aktionen — detaillierte Anwendungsbereiche
Scope Description
read:page:confluence Seiteninhalt anzeigen.
write:page:confluence Seiten erstellen und aktualisieren.
read:space:confluence Greifen Sie auf Informationen zum Speicherplatz zu.

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

Bereiten Sie die Authentifizierung vor

Confluence Cloud Action Connectors unterstützen zwei Authentifizierungsmethoden. Sammeln Sie die erforderlichen Anmeldeinformationen, bevor Sie Amazon Quick konfigurieren.

Benutzerauthentifizierung (3LO)

Wenn du die Einrichtung der Atlassian Developer Console im vorherigen Abschnitt abgeschlossen hast, solltest du die folgenden Werte bereit haben. Geben Sie diese ein, wenn Sie die Integration in Amazon Quick konfigurieren.

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

  • Client-ID — Auf der Einstellungsseite deiner Atlassian-App OAuth .

  • Geheimer Client-Schlüssel — Auf der Einstellungsseite deiner OAuth Atlassian-App.

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

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

  • URL umleiten — https://region.quicksight.aws.amazon.com/sn/oauthcallback

Dienstauthentifizierung (API-Schlüssel)

Erkundigen Sie sich bei Ihrem Confluence Cloud-Administrator nach den folgenden Informationen:

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

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

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

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 Confluence Cloud und wähle die Schaltfläche Hinzufügen (plus „+“).

  4. Wähle auf der Seite Integrationstyp die Option Aktionen in Atlassian Confluence Cloud ausführen und dann Weiter aus.

  5. Fülle im Formular „Integration erstellen“ die folgenden Felder aus:

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

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

    • Verbindungstyp — Wählen Sie Öffentliches Netzwerk.

  6. 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 Confluence-Instanz-URL für API-Aufrufe im folgenden Format. https://api.atlassian.com/ex/confluence/yourInstanceId Um Ihre Instanz-ID zu finden, navigieren Sie zu. https://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 — Confluence-API-Token.

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

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

  7. Wählen Sie Erstellen und fortfahren.

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

Verfügbare Aktionen

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

Verfügbare Aktionen in Confluence Cloud
Action Description
Seite erstellen Erstelle eine neue Seite.
Holen Sie sich Seiten Alle Seiten anzeigen.
Suchen Suchen Sie Inhalte mit CQL.
Seite aktualisieren Seiteninhalt aktualisieren.

Verwaltung und Problembehebung

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 API-Token — Wenn du die Serviceauthentifizierung verwendest, überprüfe, ob das API-Token nicht abgelaufen ist, und generiere bei Bedarf ein neues.

  • Falsche Basis-URL — Die Basis-URL für API-Aufrufe ist nicht identisch mit der Confluence Cloud-Login-URL. Stellen Sie sicher, dass Sie das API-URL-Format verwenden:. https://api.atlassian.com/ex/confluence/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 Confluence Cloud. Wenden Sie sich an Ihren Confluence 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.