OAuth-App erstellen¶
TCM365 verwendet OAuth 2.0 (3-Legged) für den Zugriff auf Jira und Confluence sowie optional einen Admin API Key für Org Security (Guard Standard). Diese Anleitung beschreibt, wie Sie die erforderliche App bei Atlassian registrieren.
Voraussetzungen¶
- Atlassian Cloud Account mit Site-Admin-Rechten
- Zugriff auf developer.atlassian.com
- Die URL Ihrer TCM365-Instanz (z.B.
https://tcm365.meinefirma.de)
Schritt 1: OAuth 2.0 App erstellen¶
- Öffnen Sie developer.atlassian.com und melden Sie sich mit Ihrem Atlassian-Account an
- Klicken Sie auf "Create" > "OAuth 2.0 integration"
- Vergeben Sie einen Namen, z.B. "TCM365"
- Unter "Callback URL" tragen Sie ein:
https://<Ihre-TCM365-URL>/api/v1/auth/atlassian/callback
Callback URL exakt eingeben
Die Callback URL muss exakt mit der URL Ihrer TCM365-Instanz uebereinstimmen, einschliesslich Protokoll (https) und Pfad. Eine abweichende URL führt dazu, dass die OAuth-Autorisierung fehlschlägt.
Schritt 2: Jira Scopes konfigurieren¶
Unter "Permissions" im Bereich "Jira API" aktivieren Sie folgende Scopes:
| Scope | Beschreibung | Wofuer |
|---|---|---|
read:jira-work |
Jira Issues und Projekte lesen | Projekt-Konfigurationen erfassen |
read:jira-configuration |
Jira-Konfiguration lesen | Permission Schemes, Workflows, Field Configurations |
write:jira-configuration |
Jira-Konfiguration schreiben | Rollback von Jira-Einstellungen |
Write-Scope optional
Wenn Sie nur Snapshots, Drift-Erkennung und Compliance-Checks nutzen möchten, genuegen die beiden Read-Scopes. Den Write-Scope benötigen Sie nur für Rollback-Operationen.
Schritt 3: Confluence Scopes konfigurieren¶
Im Bereich "Confluence API" aktivieren Sie folgende Scopes:
| Scope | Beschreibung | Wofuer |
|---|---|---|
read:confluence-content |
Confluence-Inhalte lesen | Space-Konfigurationen erfassen |
read:confluence-configuration |
Confluence-Konfiguration lesen | Space Permissions, Templates |
write:confluence-configuration |
Confluence-Konfiguration schreiben | Rollback von Confluence-Einstellungen |
Schritt 4: Admin Scopes konfigurieren (optional -- Guard Standard)¶
Falls Sie über ein Atlassian Guard Standard Abonnement verfuegen und Org Security Resource Types überwachen möchten, aktivieren Sie zusätzlich im Bereich "Admin API":
| Scope | Beschreibung | Wofuer |
|---|---|---|
read:organization |
Organisation lesen | Org-Level Security Policies |
manage:organization |
Organisation verwalten | Rollback von Org-Policies |
read:audit-logs |
Audit Logs lesen | Change Attribution |
manage:audit-logs |
Audit Logs verwalten | Audit Log Settings |
manage:organization-apps |
Org-Apps verwalten | App-Installationen überwachen |
Ohne Guard Standard
Falls Sie Guard Standard nicht nutzen, können Sie die Admin Scopes weglassen. TCM365 erkennt automatisch, welche Scopes verfügbar sind, und deaktiviert die Org Security Resource Types entsprechend.
Schritt 5: Credentials sichern¶
- Nach dem Speichern der App werden Client ID und Client Secret angezeigt
- Kopieren Sie beide Werte und bewahren Sie sie sicher auf
Client Secret schützen
Das Client Secret ist vertraulich und darf nicht in E-Mails, Tickets oder öffentlichen Dokumenten weitergegeben werden. Behandeln Sie es wie ein Passwort.
Schritt 6: Admin API Key erstellen (optional -- Guard Standard)¶
Für den Zugriff auf Org Security Resource Types wird zusätzlich ein Admin API Key benötigt:
- Öffnen Sie admin.atlassian.com
- Navigieren Sie zu Settings > API Keys
- Klicken Sie auf "Create API Key"
- Vergeben Sie einen Namen, z.B. "TCM365 Admin"
- Setzen Sie ein angemessenes Ablaufdatum
- Kopieren Sie den generierten API Key und die Organization ID
API Key Ablaufdatum
Admin API Keys haben ein Ablaufdatum. Notieren Sie sich dieses Datum und erneuern Sie den Key rechtzeitig, um Unterbrechungen in der Überwachung zu vermeiden.
Zusammenfassung der Credentials¶
Nach Abschluss sollten Sie folgende Werte bereit haben:
| Credential | Quelle | Erforderlich |
|---|---|---|
| Client ID | developer.atlassian.com > Ihre App | Ja |
| Client Secret | developer.atlassian.com > Ihre App | Ja |
| Admin API Key | admin.atlassian.com > API Keys | Nur für Guard Standard |
| Organization ID | admin.atlassian.com > Organization | Nur für Guard Standard |
Nächster Schritt¶
Fahren Sie fort mit Tenant in TCM365 verbinden, um die OAuth-Autorisierung abzuschliessen und die Verbindung zu testen.