ワークスペース
ワークスペース、ワークスペースのチェックアウト、メンバーを管理します。
ワークスペース系エンドポイントは Bearer 認証を要求します。
ワークスペース
| メソッド | パス | 用途 |
|---|---|---|
| GET | /v1/workspaces |
アクセスできるワークスペースを一覧 |
| POST | /v1/workspaces |
ワークスペースを作成 |
| PATCH | /v1/workspaces/:workspaceId |
ワークスペースの設定を更新 |
| POST | /v1/workspaces/:workspaceId/checkout |
ワークスペースのチェックアウト URL を取得 |
ワークスペースのプランは basic または pro です。
ワークスペースの name はサブドメインの制約に従います。3〜30文字、英小文字、数字、ハイフンのみ利用できます。予約語は拒否されます。PATCH /v1/workspaces/:workspaceId は PATCH 方式で、省略した項目は維持されます。
ワークスペースメンバー
| メソッド | パス | 用途 |
|---|---|---|
| GET | /v1/workspaces/:workspaceId/members |
ワークスペースのメンバーを一覧 |
| PUT | /v1/workspaces/:workspaceId/members |
メンバーを一括追加 / 更新 |
| DELETE | /v1/workspaces/:workspaceId/members/:userId |
メンバー1人を削除 |
| DELETE | /v1/workspaces/:workspaceId/members |
メンバーを一括削除 |
ロールは owner, admin, member です。
メンバーの一括追加 / 更新は userIds と role を含む JSON body を受け取ります。1人でも複数人でも指定でき、指定した全ユーザーをワークスペースに追加するか、既存メンバーのロールを更新します。
{ "userIds": ["user-id-1", "user-id-2"], "role": "member" }一括削除は request body ではなく、カンマ区切りの userIds クエリパラメータを使います。DELETE の body は一部の中継環境で落とされることがあるためです。
DELETE /v1/workspaces/:workspaceId/members?userIds=user-id-1,user-id-2
Authorization: Bearer <token>一括メンバー操作は1リクエストあたり最大100ユーザー ID までです。