Workspaces
api/admin/service_accounts/workspaces
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/service_accounts/workspaces Changed · +30 / -33 lines
### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types
---- -title: Workspaces -url: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces ---- - # Workspaces ## Add Workspace To Service Account -**post** `/v1/organizations/service_accounts/{service_account_id}/workspaces` +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` Add a service account to a workspace with the given `workspace_role`.
rejected. Requires an OAuth bearer or Console session; Admin API keys are not accepted. -### Path Parameters +### Path parameters - `service_account_id: string` ID of the service account. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Body Parameters +### Body parameters - `workspace_id: string`
- `type: "service_account_workspace_member"` - - `"service_account_workspace_member"` + default: service_account_workspace_member - `workspace_id: string`
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
}' ``` -#### Response +#### Response (200) ```json {
## List Workspaces For Service Account -**get** `/v1/organizations/service_accounts/{service_account_id}/workspaces` +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` List the workspaces a service account is a member of.
the service account is active; an archived service account returns an empty list. -### Path Parameters +### Path parameters - `service_account_id: string` ID of the service account. -### Query Parameters +### Query parameters - `limit: optional number` Number of results per page. + default: 20, maximum: 100, minimum: 1 + - `page: optional string` Opaque cursor from a previous response's `next_page`. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
### Returns -- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }` +- `data: array of object` - `created_by_actor_id: string or null`
- `type: "service_account_workspace_member"` - - `"service_account_workspace_member"` + default: service_account_workspace_member - `workspace_id: string`
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
## Remove Workspace From Service Account -**delete** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` Remove a service account from a workspace.
400. Requires an OAuth bearer or Console session; Admin API keys are not accepted. -### Path Parameters +### Path parameters - `service_account_id: string`
ID of the workspace. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
- `type: "service_account_workspace_member_deleted"` - - `"service_account_workspace_member_deleted"` + default: service_account_workspace_member_deleted - `workspace_id: string`
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
} ``` -## Domain Types +## Domain types ### Workspace Create Response -- `WorkspaceCreateResponse object { created_by_actor_id, implicit, service_account_id, 3 more }` +- `WorkspaceCreateResponse object` - `created_by_actor_id: string or null`
- `type: "service_account_workspace_member"` - - `"service_account_workspace_member"` + default: service_account_workspace_member - `workspace_id: string`
### Workspace List Response -- `WorkspaceListResponse object { created_by_actor_id, implicit, service_account_id, 3 more }` +- `WorkspaceListResponse object` - `created_by_actor_id: string or null`
- `type: "service_account_workspace_member"` - - `"service_account_workspace_member"` + default: service_account_workspace_member - `workspace_id: string`
### Workspace Delete Response -- `WorkspaceDeleteResponse object { service_account_id, type, workspace_id }` +- `WorkspaceDeleteResponse object` - `service_account_id: string`
- `type: "service_account_workspace_member_deleted"` - - `"service_account_workspace_member_deleted"` + default: service_account_workspace_member_deleted - `workspace_id: string`