L’API v3 è attualmente in beta. Alcuni endpoint potrebbero cambiare man mano che miglioriamo l’API.
https://api.devin.ai/v3beta1/enterprise/*– endpoint che richiedono autorizzazioni a livello Enterprisehttps://api.devin.ai/v3beta1/organizations/*– endpoint con ambito limitato a una singola organizzazione
Alcuni endpoint Enterprise operano su organizzazioni specifiche ma sono comunque protetti da
autorizzazioni a livello Enterprise. Utilizzano percorsi come
/v3beta1/enterprise/organizations/{org_id}/...
(ad esempio, GET /v3beta1/enterprise/organizations/{org_id}/audit-logs).
Anche se includono un parametro di percorso org_id, richiedono comunque
autorizzazioni a livello Enterprise come ManageEnterpriseSettings.Autorizzazioni e RBAC
/v3beta1/enterprise/*, e le autorizzazioni a livello di organizzazione controllano gli endpoint /v3beta1/organizations/{org_id}/*. Un utente di servizio Enterprise con un’autorizzazione a livello Enterprise eredita automaticamente la corrispondente autorizzazione a livello di organizzazione in tutte le organizzazioni.
Autorizzazioni Enterprise
| Permission | Controls |
|---|---|
ReadAccountMeta | Account stesso (concessa per impostazione predefinita a tutti gli utenti di servizio) |
ManageEnterpriseSettings | Log di audit, tag dell’organizzazione |
ManageOrganizations | CRUD delle organizzazioni, limiti dei gruppi di organizzazioni |
ManageAccountMembership | Ruoli, utenti Enterprise, gruppi IdP Enterprise, appartenenza degli utenti di servizio Enterprise, registrazione dei gruppi IdP Enterprise |
ManageAccountServiceUsers | Provisioning degli utenti di servizio (enterprise) |
ManageAccountKnowledge | Note Knowledge (enterprise) |
ManageAccountPlaybooks | Playbook (enterprise) |
ManageGitIntegrations | Connessioni Git, autorizzazioni Git |
ManageBilling | Cicli di consumo, ripartizioni giornaliere del consumo |
ViewAccountMetrics | Metriche di utilizzo (DAU/WAU/MAU, PR, sessioni, ricerche, utenti attivi), stato della coda |
ViewEnterpriseInfraDetails | Hypervisor |
ViewAccountSessions | Elenco e dettagli delle sessioni (enterprise, sola lettura) |
ManageAccountSessions | Invio di messaggi alle sessioni (enterprise) |
ViewAccountSearches | Ricerche (enterprise) |
Autorizzazioni dell’organizzazione
| Permission | Controls |
|---|---|
ManageOrgSecrets | Operazioni CRUD sui segreti |
ManageOrgKnowledge | Note di Knowledge (organizzazione) |
ManageOrgPlaybooks | Playbook (organizzazione) |
ManageOrgServiceUsers | Provisioning degli utenti di servizio (organizzazione) |
ViewOrgSessions | Elenco e dettagli delle sessioni (organizzazione, solo lettura) |
ManageOrgSessions | Inviare messaggi, terminare, archiviare le sessioni |
UseDevinSessions | Creare sessioni |
ImpersonateOrgSessions | Creare sessioni per conto di altri utenti (create_as_user_id) |
ViewOrgSearches | Ricerche (organizzazione) |
Ambiti degli utenti di servizio
/v3beta1/enterprise/* e possono operare su tutte le organizzazioni. Hanno ruoli a livello di Enterprise ed ereditano automaticamente le corrispondenti autorizzazioni a livello di organizzazione in ogni organizzazione (ad esempio, ViewAccountSessions concede ViewOrgSessions in tutte le org).
Gli utenti di servizio di organizzazione sono limitati a una singola organizzazione e si autenticano solo tramite gli endpoint /v3beta1/organizations/{org_id}/*. A loro vengono assegnati ruoli a livello di organizzazione.
Creazione di utenti di servizio
- UI: Enterprise Settings → Service Users — crea utenti di servizio a livello Enterprise o a livello di organizzazione con ruoli personalizzati e genera token API.
- API:
POST /v3beta1/enterprise/service-usersoPOST /v3beta1/organizations/{org_id}/service-users— esegui il provisioning in modo programmatico di utenti di servizio con un ruolo e un TTL specificati. Le autorizzazioni del nuovo utente devono essere un sottoinsieme delle autorizzazioni del chiamante (l’escalation dei privilegi è prevenuta).
Self
Log di audit
Log di audit Enterprise
Ottieni i log di audit a livello Enterprise
Log di audit dell'organizzazione
Ottieni i log di audit per una determinata organizzazione
Consumo
Cicli di consumo
Visualizza i riepiloghi dei cicli di consumo
Consumo giornaliero
Visualizza la ripartizione giornaliera del consumo
Per organizzazione
Monitora il consumo per organizzazione
Per utente
Monitora il consumo per utente
Per sessione
Monitora il consumo per sessione
Organizzazioni
Elenca organizzazioni
Visualizza tutte le organizzazioni
Crea organizzazione
Crea una nuova organizzazione
Aggiorna organizzazione
Aggiorna le impostazioni dell’organizzazione
Elimina organizzazione
Elimina un’organizzazione
Utenti di servizio
Elenca utenti di servizio Enterprise
Visualizza gli utenti di servizio Enterprise
Crea utente di servizio Enterprise
Crea un utente di servizio Enterprise
Aggiorna utente di servizio Enterprise
Aggiorna un utente di servizio Enterprise
Elimina utente di servizio Enterprise
Elimina un utente di servizio Enterprise
Elenca utenti di servizio dell'organizzazione
Visualizza gli utenti di servizio dell’organizzazione
Crea utente di servizio dell'organizzazione
Crea un utente di servizio dell’organizzazione
Utenti
Elenca utenti Enterprise
Visualizza gli utenti Enterprise
Aggiungi utente Enterprise
Aggiungi un utente all’Enterprise
Aggiorna utente Enterprise
Aggiorna un utente Enterprise
Rimuovi utente Enterprise
Rimuovi un utente dall’Enterprise
Elenca utenti organizzazione
Visualizza gli utenti dell’organizzazione
Aggiungi utente organizzazione
Aggiungi un utente a un’organizzazione
Gruppi IdP
Elenca i gruppi Enterprise registrati
Elenca i gruppi IdP registrati per questa Enterprise
Registra gruppi Enterprise
Registra gruppi IdP per questa Enterprise
Rimuovi gruppo Enterprise registrato
Rimuovi un gruppo IdP registrato per questa Enterprise
Elenca gruppi Enterprise
Visualizza le assegnazioni dei gruppi IdP a livello Enterprise
Assegna gruppo Enterprise
Assegna un ruolo di gruppo IdP a livello Enterprise
Elenca gruppi dell'organizzazione
Visualizza le assegnazioni dei gruppi IdP a livello di organizzazione
Assegna gruppo dell'organizzazione
Assegna un ruolo di gruppo IdP a livello di organizzazione
Autorizzazioni Git
Elenca autorizzazioni
Visualizza le autorizzazioni Git per un’organizzazione
Aggiungi autorizzazione
Aggiungi un’autorizzazione Git
Rimuovi autorizzazione
Rimuovi un’autorizzazione Git
Note
Elenca note Enterprise
Visualizza le note di conoscenza a livello Enterprise
Crea nota Enterprise
Crea una nuova nota di conoscenza a livello Enterprise
Elenca note organizzazione
Visualizza le note di conoscenza a livello di organizzazione
Crea nota organizzazione
Crea una nuova nota di conoscenza a livello dell’organizzazione
Playbook
Elenca playbook Enterprise
Visualizza i playbook Enterprise
Crea playbook Enterprise
Crea un nuovo playbook Enterprise
Elenca playbook dell'organizzazione
Visualizza i playbook dell’organizzazione
Crea playbook dell'organizzazione
Crea un nuovo playbook dell’organizzazione
Sessioni
Elenca le sessioni
Visualizza le sessioni dell’organizzazione
Crea sessione
Crea una nuova sessione
Termina sessione
Termina una sessione attiva
Archivia sessione
Archivia una sessione per riferimento futuro
Visualizza tag
Visualizza i tag di un’organizzazione
Aggiungi tag
Aggiungi tag a un’organizzazione
Sostituisci tag
Sostituisci tutti i tag di un’organizzazione
Elimina tag
Rimuovi un tag specifico
Ruoli e metriche
Elenca ruoli
Visualizza i ruoli disponibili
Metriche di utilizzo
Recupera le metriche di utilizzo Enterprise
Metriche dell'organizzazione
Recupera le metriche di utilizzo dell’organizzazione
Esempi di utilizzo
Visualizza esempi di codice
Scopri esempi di codice e casi d’uso comuni per l’API v3