Passer au contenu principal
L’API v3 fournit une prise en charge complète de RBAC avec authentification d’utilisateur de service. C’est l’API recommandée pour l’automatisation en production.
L’API v3 est actuellement en bêta. Certains points de terminaison peuvent changer à mesure que nous améliorons l’API.
URL de base :
  • https://api.devin.ai/v3beta1/enterprise/* – points de terminaison qui nécessitent des autorisations Enterprise (au niveau du compte)
  • https://api.devin.ai/v3beta1/organizations/* – points de terminaison limités à une seule organisation
Authentification : identifiants d’utilisateur de service (niveau Enterprise ou organisation) (en savoir plus)
Certains points de terminaison Enterprise s’appliquent à des organisations spécifiques, mais restent protégés par des autorisations au niveau Enterprise. Ils utilisent des chemins du type /v3beta1/enterprise/organizations/{org_id}/... (par exemple, GET /v3beta1/enterprise/organizations/{org_id}/audit-logs). Même s’ils incluent un paramètre de chemin org_id, ils exigent toujours des autorisations au niveau Enterprise telles que ManageEnterpriseSettings.

Autorisations et RBAC

L’API v3 utilise un contrôle d’accès basé sur les rôles (RBAC) avec des utilisateurs de service. Chaque endpoint requiert des autorisations spécifiques qui sont attribuées au rôle de l’utilisateur de service. Les utilisateurs de service peuvent être créés soit au niveau Enterprise, soit au niveau de l’organisation, et leurs autorisations déterminent quels endpoints ils peuvent consulter.

Types d’autorisations

L’API v3 utilise les autorisations suivantes :
AutorisationDescriptionEndpoints
ManageAccountKnowledgeGérer les notes Knowledge au niveau de l’Enterprise ou de l’organisationEndpoints Notes (GET, POST, PUT, DELETE)
ManageAccountPlaybooksGérer les playbooks au niveau de l’Enterprise ou de l’organisationEndpoints Playbooks (GET, POST, PUT, DELETE)
ManageEnterpriseSettingsGérer les paramètres globaux de l’offre Enterprise, y compris les tags d’organisationEndpoints Tags, gestion des organisations

Périmètres des utilisateurs de service

Les Enterprise Service Users ont accès aux ressources à l’échelle de l’Enterprise et peuvent opérer sur toutes les organisations au sein de l’Enterprise. Ils utilisent les endpoints sous /v3beta1/enterprise/*. Les Organization Service Users sont limités à une organisation spécifique et ne peuvent accéder qu’aux ressources de cette organisation. Ils utilisent les endpoints sous /v3beta1/organizations/{org_id}/*.

Création d’utilisateurs de service

Les utilisateurs de service peuvent être créés via :
  • Paramètres Enterprise → Utilisateurs de service : créez des utilisateurs de service au niveau de l’Enterprise ou au niveau de l’organisation avec des rôles personnalisés
Pour plus d’informations sur l’authentification et la création de jetons, consultez le Guide d’authentification.

Self

Obtenez des informations sur l’utilisateur de service authentifié :

Journaux d’audit

Accédez à des journaux d’audit complets :

Consommation

Suivez des métriques détaillées de consommation :

Organisations

Gérez les organisations avec un RBAC complet :

Utilisateurs de service

Gérer les utilisateurs de service aux niveaux entreprise et organisation :

Utilisateurs

Gérez les utilisateurs aux niveaux Enterprise et organisation :

Groupes IdP

Gérez les groupes IdP aux niveaux Enterprise et organisation :

Autorisations Git

Gérer l’accès au dépôt :

Notes

Gérez les notes Knowledge aux niveaux Enterprise et organisation :

Playbooks

Gérez les playbooks aux niveaux Enterprise et organisation :

Sessions

Gérer les sessions de l’organisation :

Tags

Gérer les tags d’organisation (nécessite la fonctionnalité de tags de session) :

Rôles et métriques

Exemples d’utilisation

Voir les exemples de code

Découvrez des exemples de code et des cas d’usage courants de l’API v3