Principals & Token
Alle API-Zugangsdaten verwenden das Präfixformat
cog_. Fügen Sie Ihr Token in den Authorization-Header jeder Anfrage ein:
- Ein Service User API Key authentifiziert als der Service-Benutzer — es gelten die Identität, Berechtigungen und Org-Mitgliedschaften des Service-Benutzers.
- Ein Personal Access Token authentifiziert als der menschliche Nutzer, der ihn erstellt hat — es gelten die Identität, Berechtigungen und Org-Mitgliedschaften dieses Nutzers.
Service-Benutzer (empfohlen für die Automatisierung)
So funktioniert es
- Erstellen Sie einen Service-Benutzer unter Settings > Service users (Organisation) oder Enterprise settings > Service users (Enterprise)
- Weisen Sie eine Rolle zu, die steuert, auf welche Endpunkte der Service-Benutzer zugreifen kann
- Generieren Sie einen API-Key — der Schlüssel beginnt mit
cog_und wird bei der Erstellung nur einmal angezeigt - Verwenden Sie den Schlüssel im
Authorization-Header jeder API-Anfrage
Service-Benutzer-Geltungsbereiche
Sitzungszuordnung mit create_as_user_id
create_as_user_id. Die Sitzung erscheint dann in der Sitzungsliste dieses Nutzers und wird auf seine Nutzung angerechnet.
Dafür ist die Berechtigung ImpersonateOrgSessions in der Rolle des Service-Benutzers erforderlich.
Wichtige Eigenschaften
- Schlüssel beginnen mit
cog_und werden nur einmal bei der Erstellung angezeigt - Service-Benutzer werden in Audit-Protokollen getrennt von menschlichen Benutzern aufgeführt
- Berechtigungen werden über RBAC gesteuert – weisen Sie nur die Berechtigungen zu, die die Integration benötigt
- Enterprise-Service-Benutzer erben organisationsweite Berechtigungen über alle Organisationen hinweg
Personal Access Tokens (geschlossene Beta)
Personal Access Tokens befinden sich derzeit in der geschlossenen Beta und sind per Feature-Flag aktiviert. Kontaktieren Sie den Support, um Zugriff zu erhalten. PATs sind für SSO-/Enterprise-Konten nicht verfügbar.
Legacy-Authentifizierung (veraltet)
Wo zu erstellen: Settings > API Keys
Best Practices zur Sicherheit
- Schlüssel sicher speichern: Verwenden Sie Umgebungsvariablen oder Systeme zum Secret-Management
- Schlüssel regelmäßig erneuern: Generieren Sie regelmäßig neue Schlüssel und widerrufen Sie alte
- Service-User für Automatisierung verwenden: Bevorzugen Sie Service-User gegenüber persönlichen Schlüsseln in Produktionsumgebungen
- Least-Privilege-Prinzip anwenden: Gewähren Sie nur die minimal erforderlichen Berechtigungen
- Nutzung überwachen: Prüfen Sie Audit-Logs auf unerwartete API-Aktivitäten
- Kompromittierte Schlüssel sofort widerrufen: Wenn ein Schlüssel offengelegt wurde, widerrufen Sie ihn und generieren Sie einen neuen
Fehlerbehebung
- Ungültige oder abgelaufene API key
- Fehlender
Authorization-Header - Falsches Bearer-Token-Format
- Verwendung einer legacy API key (
apk_/apk_user_) mit Devin MCP — nur Schlüssel mit dem Präfixcog_werden unterstützt
Authorization-Header korrekt formatiert ist. Stellen Sie bei der MCP-Nutzung sicher, dass Sie eine API key eines Service-Benutzers verwenden (keinen legacy key).
403 Forbidden
- Der API key verfügt nicht über die erforderlichen Berechtigungen
- Du verwendest den falschen Schlüsseltyp für den Endpoint (z. B. Legacy-Schlüssel mit v3-Endpoints)
- Du versuchst, auf Ressourcen außerhalb deines Zugriffsbereichs zuzugreifen
- Stelle sicher, dass dein Servicebenutzer die richtige Rolle und die erforderlichen Berechtigungen hat
- Für Legacy-v2-Endpoints: Stelle sicher, dass du die Enterprise-Admin-Rolle hast
- Für Legacy-v1-Endpoints: Überprüfe, ob du Zugriff auf die Organisation hast
404 Nicht gefunden
- Falsche API-Endpunkt-URL
- Ressource existiert nicht oder Sie haben keinen Zugriff
Nächste Schritte
- Schnellstart für Teams — in wenigen Minuten loslegen
- Enterprise-Schnellstart — RBAC- und Multi-Org-Einrichtung
- Häufige Workflows — Beispiele für End-to-End-Workflows
- Migrationsleitfaden — Migration von v1/v2

