個人 API キーの発行
個人 API キーの発行
REST API や MCP 連携で Docmost にアクセスするための 個人 API キー の発行・管理手順です。
Enterprise 機能: 個人 API キーは Enterprise ライセンスが必要です。ワークスペース管理者が API キー機能を有効にしている必要があります。
こんなときに読む
- スクリプトや CI から Docmost API を呼びたい
- MCP クライアント（Cursor 等）に Docmost を接続したい
- 自分用の API キーを発行・失効したい
画面を開く
| 種類 | URL | 権限 |
|---|---|---|
| 個人 API キー | /settings/account/api-keys |
WS Member（管理者制限があれば Admin のみ） |
| ワークスペース API キー（管理者用） | /settings/api-keys |
WS Admin / Owner |
個人キーは 自分のアカウント に紐づきます。ワークスペースキーは管理者がサービスアカウント用途で発行します。
個人 API キーの発行手順
- Settings > Account > API keys（
/settings/account/api-keys）を開く - Create API key をクリック
- 名前（用途のメモ）を入力して作成
- 表示された シークレットをコピー（再表示不可）
- API クライアントや MCP 設定に保存
シークレットは作成直後の一度だけ表示されます。紛失した場合は失効して再発行してください。
管理操作
| 操作 | 説明 |
|---|---|
| 名前の変更 | キー一覧から Update |
| 失効（Revoke） | 即座に無効化。復元不可 |
| 一覧確認 | 作成日・最終利用（あれば）を確認 |
MCP との関係
ワークスペースで MCP が有効な場合、個人 API キーは MCP エンドポイント（{APP_URL}/mcp）の認証にも使えます。
→ 詳細: 「MCP 連携設定」（No.9.3）
管理者向けの制限設定
WS Admin は次を設定できます。
- API キー作成を Admin に限定 … Member の個人キー発行を禁止
- ワークスペース API キー … バッチ処理・統合向けの共有キー
セキュリティの注意
- キーはパスワードと同様に扱い、リポジトリやチャットに貼らない
- 不要になったキーは速やかに Revoke
- 最小権限の原則 … 可能なら用途別にキーを分ける
関連ナレッジ
- REST API: 「REST API の使い方」（No.9.5）
- MCP: 「MCP 連携設定」（No.9.3）
- 権限: 「用語と権限」（No.2.2）
- EE 機能差: 「OSS と Enterprise の機能差早見表」（No.2.8）