メインコンテンツへスキップ
v3 API は、サービスユーザー認証付きのフル RBAC サポートを提供します。本番環境での自動化には、この API の利用を推奨します。
v3 API は現在ベータ版です。API の改善に伴い、一部のエンドポイントは変更される可能性があります。
ベース URL:
  • https://api.devin.ai/v3beta1/enterprise/*エンタープライズレベルの権限が必要なエンドポイント
  • https://api.devin.ai/v3beta1/organizations/* – 単一の組織を対象とするエンドポイント
認証方式: サービスユーザーの認証情報(エンタープライズまたは組織レベル) (詳細はこちら)
一部のエンタープライズエンドポイントは特定の組織を対象としますが、 それでもエンタープライズレベルの権限で保護されています。これらは /v3beta1/enterprise/organizations/{org_id}/... のようなパスを使用します(例: GET /v3beta1/enterprise/organizations/{org_id}/audit-logs)。 org_id パスパラメータを含んでいても、ManageEnterpriseSettings のような エンタープライズレベルの権限が引き続き必要です。

権限とRBAC

すべてのv3エンドポイントは、呼び出し元のサービスユーザーのロールに割り当てられた特定の権限によって制御されています。権限には2つのスコープがあります。Enterpriseレベルの権限は /v3beta1/enterprise/* エンドポイントを制御し、組織レベルの権限は /v3beta1/organizations/{org_id}/* エンドポイントを制御します。Enterpriseレベルの権限を持つ Enterprise サービスユーザーは、すべての組織に対して対応する組織レベルの権限を自動的に継承します。

Enterprise 権限

Permission制御対象
ReadAccountMeta自分自身(デフォルトですべてのサービスユーザーに付与)
ManageEnterpriseSettings監査ログ、Organization タグ
ManageOrganizationsOrganization の CRUD、Organization グループ数の上限
ManageAccountMembershipロール、Enterprise ユーザー、Enterprise IdP グループ、Enterprise サービスユーザーのメンバーシップ、Enterprise IdP グループ登録
ManageAccountServiceUsersサービスユーザーのプロビジョニング(Enterprise)
ManageAccountKnowledgeKnowledge ノート(Enterprise)
ManageAccountPlaybooksPlaybook(Enterprise)
ManageGitIntegrationsGit 接続、Git 権限
ManageBilling利用サイクル、日次の利用内訳
ViewAccountMetrics利用状況メトリクス(DAU/WAU/MAU、PR(プルリクエスト)、セッション、検索、アクティブユーザー)、キューのステータス
ViewEnterpriseInfraDetailsハイパーバイザー
ViewAccountSessionsセッションの一覧と詳細(Enterprise、読み取り専用)
ManageAccountSessionsセッションへのメッセージの送信(Enterprise)
ViewAccountSearches検索(Enterprise)

組織権限

PermissionControls
ManageOrgSecretsシークレットの CRUD
ManageOrgKnowledgeKnowledge ノート(組織)
ManageOrgPlaybooksPlaybook(組織)
ManageOrgServiceUsersサービスユーザーのプロビジョニング(組織)
ViewOrgSessionsセッションの一覧および詳細(組織、読み取り専用)
ManageOrgSessionsメッセージの送信、セッションの終了およびアーカイブ
UseDevinSessionsセッションの作成
ImpersonateOrgSessions他のユーザーになり代わってセッションを作成(create_as_user_id
ViewOrgSearches検索(組織)

サービスユーザーのスコープ

Enterprise サービスユーザー/v3beta1/enterprise/* エンドポイントで認証を行い、すべての組織をまたいで操作できます。Enterprise レベルのロールが割り当てられ、各ロールに対応する組織レベルの権限を、すべての組織で自動的に継承します(たとえば、ViewAccountSessions はすべての組織で ViewOrgSessions を付与します)。 Organization サービスユーザー は単一の組織のみにスコープが限定され、/v3beta1/organizations/{org_id}/* エンドポイントでのみ認証されます。これらのユーザーには組織レベルのロールが割り当てられます。

サービスユーザーの作成

サービスユーザーは次の 2 通りの方法で作成できます。
  1. UI: Enterprise Settings → Service Users — カスタムロールを指定して Enterprise または組織レベルのサービスユーザーを作成し、API トークンを生成します。
  2. API: POST /v3beta1/enterprise/service-users または POST /v3beta1/organizations/{org_id}/service-users — 指定したロールと TTL を用いて、プログラムからサービスユーザーをプロビジョニングします。新しいユーザーの権限は必ず呼び出し元ユーザーの権限のサブセットである必要があります(特権昇格は許可されません)。
トークン生成および認証の詳細については、Authentication Guide を参照してください。

Self

認証済みサービスユーザーの情報を取得します。

監査ログ

包括的な監査証跡にアクセスします:

利用状況

詳細な利用量指標を追跡できます:

組織

RBAC によるアクセス制御で組織を管理:

サービスユーザー

Enterprise レベルおよび組織レベルのサービスユーザーを管理します。

ユーザー

Enterprise レベルおよび組織レベルのユーザーを管理します。

IdP グループ

Enterprise レベルおよび組織レベルで IdP グループを管理します。

Git 権限

リポジトリへのアクセス権を管理します:

ノート

Enterprise レベルおよび組織レベルでのナレッジノートを管理します。

プレイブック

Enterprise レベルおよび組織レベルでプレイブックを管理します。

セッション

組織内のセッションを管理します:

タグ

組織のタグを管理します(セッションタグ機能が必要です):

ロールとメトリクス

使用例

コード例を表示

v3 API のコード例と代表的なユースケースを確認してください