Workspaces
Workspace、workspace checkout、workspace members を管理します。
Workspace endpoint は bearer authentication を要求します。
Workspaces
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/workspaces |
Accessible workspaces を list |
| POST | /v1/workspaces |
Workspace を作成 |
| PATCH | /v1/workspaces/:workspaceId |
Workspace settings を更新 |
| POST | /v1/workspaces/:workspaceId/checkout |
Workspace checkout URL を取得 |
Workspace plan は basic または pro です。
Workspace name は subdomain constraints に従います。3〜30 文字、lowercase letters、numbers、hyphens のみ利用できます。Reserved names は reject されます。PATCH /v1/workspaces/:workspaceId は PATCH semantics で、省略 fields は維持されます。
Workspace members
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/workspaces/:workspaceId/members |
Workspace members を list |
| PUT | /v1/workspaces/:workspaceId/members |
Members を bulk add/update |
| DELETE | /v1/workspaces/:workspaceId/members/:userId |
1 member を remove |
| DELETE | /v1/workspaces/:workspaceId/members |
Members を bulk remove |
Role は owner, admin, member です。
Bulk member update は user IDs list と role を受け取ります。Bulk delete は user IDs list を受け取ります。