Zum Hauptinhalt springen
Die v3 API bietet vollständige RBAC-Unterstützung mit Service-User-Authentifizierung. Dies ist die empfohlene API für die Produktionsautomatisierung.
Die v3 API befindet sich derzeit in der Beta-Phase. Einige Endpunkte können sich ändern, während wir die API weiter verbessern.
Basis-URLs:
  • https://api.devin.ai/v3beta1/enterprise/* – Endpunkte, die Enterprise-Berechtigungen erfordern
  • https://api.devin.ai/v3beta1/organizations/* – Endpunkte, die auf eine einzelne Organisation beschränkt sind
Authentifizierung: Service-User-Anmeldedaten (auf Enterprise- oder Organisationsebene) (mehr erfahren)
Einige Enterprise-Endpunkte beziehen sich auf bestimmte Organisationen, werden aber weiterhin durch Berechtigungen auf Enterprise-Ebene geschützt. Diese verwenden Pfade wie /v3beta1/enterprise/organizations/{org_id}/... (zum Beispiel GET /v3beta1/enterprise/organizations/{org_id}/audit-logs). Auch wenn sie einen org_id-Pfadparameter enthalten, erfordern sie trotzdem Berechtigungen auf Enterprise-Ebene wie ManageEnterpriseSettings.

Berechtigungen und RBAC

Jeder v3-Endpunkt ist an eine spezifische Berechtigung gebunden, die der Rolle des aufrufenden Servicebenutzers zugewiesen ist. Berechtigungen sind in zwei Geltungsbereiche unterteilt: Enterprise-Berechtigungen (Enterprise-Ebene) steuern die Endpunkte /v3beta1/enterprise/*, und Organisationsberechtigungen steuern die Endpunkte /v3beta1/organizations/{org_id}/*. Ein Enterprise-Servicebenutzer mit einer Berechtigung auf Enterprise-Ebene erbt automatisch die entsprechende Organisationsberechtigung für alle Organisationen.

Enterprise-Berechtigungen

BerechtigungUmfasst
ReadAccountMetaEigenes Konto (wird standardmäßig allen Servicebenutzern gewährt)
ManageEnterpriseSettingsAudit-Logs, Organisationstags
ManageOrganizationsCRUD für Organisationen, Grenzwerte für Organisationsgruppen
ManageAccountMembershipRollen, Enterprise-Benutzer, Enterprise-IdP-Gruppen, Mitgliedschaft von Enterprise-Servicebenutzern, Registrierung von Enterprise-IdP-Gruppen
ManageAccountServiceUsersBereitstellung von Servicebenutzern (Enterprise)
ManageAccountKnowledgeKnowledge-Notizen (Enterprise)
ManageAccountPlaybooksPlaybooks (Enterprise)
ManageGitIntegrationsGit-Verbindungen, Git-Berechtigungen
ManageBillingVerbrauchszyklen, tägliche Verbrauchsübersichten
ViewAccountMetricsNutzungsmetriken (DAU/WAU/MAU, PRs, Sitzungen, Suchvorgänge, aktive Benutzer), Warteschlangenstatus
ViewEnterpriseInfraDetailsHypervisoren
ViewAccountSessionsSitzungsliste und -details (Enterprise, schreibgeschützt)
ManageAccountSessionsNachrichten an Sitzungen senden (Enterprise)
ViewAccountSearchesSuchvorgänge (Enterprise)

Organisationsberechtigungen

BerechtigungSteuert
ManageOrgSecretsSecrets (CRUD)
ManageOrgKnowledgeKnowledge-Notizen (Organisation)
ManageOrgPlaybooksPlaybooks (Organisation)
ManageOrgServiceUsersBereitstellung von Service-Usern (Organisation)
ViewOrgSessionsSitzungsübersicht und -details (Organisation, schreibgeschützt)
ManageOrgSessionsNachrichten senden, Sitzungen beenden und archivieren
UseDevinSessionsSitzungen erstellen
ImpersonateOrgSessionsSitzungen im Namen anderer Nutzer erstellen (create_as_user_id)
ViewOrgSearchesSuchvorgänge (Organisation)

Berechtigungsbereiche von Servicebenutzern

Enterprise-Servicebenutzer authentifizieren sich an /v3beta1/enterprise/*-Endpunkten und können über alle Organisationen hinweg arbeiten. Ihnen werden Rollen auf Enterprise-Ebene zugewiesen, und sie erben automatisch die entsprechenden Berechtigungen auf Orgebene in jeder Organisation (zum Beispiel gewährt ViewAccountSessions die Berechtigung ViewOrgSessions in allen Organisationen). Organisationsservicebenutzer sind auf eine einzelne Organisation beschränkt und authentifizieren sich ausschließlich an /v3beta1/organizations/{org_id}/*-Endpunkten. Ihnen werden Rollen auf Orgebene zugewiesen.

Erstellen von Service-Benutzern

Service-Benutzer können auf zwei Arten erstellt werden:
  1. UI: Enterprise Settings → Service Users — Erstellen Sie Enterprise- oder organisationsweite Service-Benutzer mit benutzerdefinierten Rollen und generieren Sie API-Token.
  2. API: POST /v3beta1/enterprise/service-users oder POST /v3beta1/organizations/{org_id}/service-users — Service-Benutzer mit einer angegebenen Rolle und TTL programmgesteuert bereitstellen. Die Berechtigungen des neuen Benutzers müssen eine Teilmenge der Berechtigungen des Aufrufers sein (Privilegieneskalation wird verhindert).
Details zur Generierung von Token und zur Authentifizierung finden Sie im Authentication Guide.

Self

Informationen zum authentifizierten Servicebenutzer abrufen:

Audit-Logs

Greifen Sie auf umfassende Audit-Protokolle zu:

Verbrauch

Detaillierte Verbrauchsmetriken verfolgen:

Organisationen

Verwalten Sie Organisationen mit umfassendem RBAC:

Servicebenutzer

Verwalten Sie Servicebenutzer auf Enterprise- und Organisationsebene:

Benutzer

Benutzer auf Enterprise- und Organisationsebene verwalten:

IdP-Gruppen

IdP-Gruppen auf Enterprise- und Organisationsebene verwalten:

Git-Berechtigungen

Repositoryzugriff verwalten:

Notizen

Verwalten Sie Knowledge-Notizen auf Enterprise- und Organisationsebene:

Playbooks

Verwalten Sie Playbooks auf Enterprise- und Organisationsebene:

Sitzungen

Sitzungen einer Organisation verwalten:

Tags

Organisationstags verwalten (erfordert die Session-Tags-Funktion):

Rollen & Metriken

Anwendungsbeispiele

Codebeispiele ansehen

Codebeispiele und typische Anwendungsfälle der v3-API ansehen