> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# エンタープライズ APIs

> Difyエンタープライズ版バージョン ≥ v2.2.0 が必要

エンタープライズ APIは REST API仕様に準拠しており、Difyエンタープライズプラットフォーム内での効率的な自動化管理を実現します。以下のリソースに対する情報の照会と変更をサポートしています：

* **Workspaces**：グローバルワークスペース管理。ワークスペース情報の取得、作成、管理操作をサポート。
* **Members**：グローバルチームメンバー管理。チームメンバー情報の取得、メンバーの追加と管理をサポート。
* **Workspace Member**：ワークスペースメンバー管理。特定のワークスペース内のメンバー情報の取得、メンバー管理などの操作をサポート。

> バージョンの更新とともに、より多くの機能がサポートされる予定です。

## APIの種類

Difyプラットフォームには異なるレベルのAPIサービスが存在します。混乱を避けるため、以下のように区別しています：

* アプリケーション内で提供されるAPIは **Workspace API** と呼ばれます。

* Difyプラットフォームの管理操作用APIは、総称して **Admin API** と呼ばれます。

## エンドポイント URL

エンタープライズ APIは以下のエンドポイントアドレスを使用します。実際にAPIを呼び出す際は、`your-domain`をお使いのDifyエンタープライズプラットフォームのドメイン名に置き換え、各リクエストのパスを後ろに追加して完全なAPIエンドポイントを形成してください。

```bash theme={null}
https://your-domain/admin-api/v1
```

## 認証

APIリクエストには認証用のSecret Keyが必要です。Difyエンタープライズ管理バックエンドの **Admin APIs** ページでKeyを作成してください。

<Warning>
  エンタープライズAPIを使用して変更を行う場合、企業内の本番データに影響を与える可能性があります。慎重に操作してください。
</Warning>

![](https://assets-docs.dify.ai/2025/02/0431242649acccbcbcf23fa8e4268ce8.png)

## 使用例

理解を深めるため、現在のワークスペース一覧（List Workspaces）の取得を例に、エンタープライズ APIの使用方法をご紹介します。

### 1. API Keyの作成

エンタープライズ版管理バックエンドにアクセスし、**Admin APIs** ページの右上にある **Add** ボタンをクリックし、指示に従って名前を入力して作成を完了します。

### 2. APIファイルのインポートと環境変数の修正

ページに表示されている **Postman Collection** ダウンロードリンクをクリックします。

![](https://assets-docs.dify.ai/2025/02/5aa925f58ec5bb12a2838704f1444525.png)

設定ファイルをPostmanにインポートし、Variables内の `base_url` と `secret_key` を置き換えます。

![](https://assets-docs.dify.ai/2025/02/786336845c4d67117fdede872eb7883b.png)

### 3. リクエストの送信

リクエストを送信し、レスポンスを受け取ります。レスポンス内で、現在のエンタープライズ版における完全なワークスペースリストとその対応する情報を確認できます。

```json theme={null}
{
    "data": [
        {
            "id": "a7145b74-****--****---****",     # ワークスペースID
            "name": "Workspace A Name",             # ワークスペース名
            "status": "normal",                     # ワークスペースの状態
            "created_at": "2025-02-08T02:45:33Z",   # ワークスペースの作成日時
            "updated_at": "2025-02-08T02:45:33Z"    # ワークスペースの更新日時
        },
        {
            "id": "bbffbfdf-****--****---****",
            "name": "Dify's Workspace",
            "status": "normal",
            "created_at": "2025-02-07T16:55:59Z",
            "updated_at": "2025-02-07T16:55:59Z"
        },
    ],
    "has_more": true,
    "limit": 10,
    "page": 1,
    "total": 491
}
```

![](https://assets-docs.dify.ai/2025/02/bd4d300b08ceed74c17c3b428329fa19.png)