One read of Claude Developer Platformapi-20260930T233759Z
343 pages moved out of 740 read.
Pages moved
343
significant first
Pages read
740
in this capture
Captured
23:37 UTC
Corpus hash
1974d9bc7c5a
index-hash
What this read moved
126-150 of 343, page 6 of 14This capture is too large to show at once. Changes 126-150 of 343 are below, significant first; the rest are on the following screens.
api/organization/service_accounts/update New page · 130 lines, new page
# Update Service Account ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Update Service Account
url: https://platform.claude.com/docs/en/api/organization/service_accounts/update
---
# Update Service Account
**POST** `/v1/organizations/service_accounts/{service_account_id}`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Update a service account.
Only `description` and `organization_role` are mutable; `name` cannot be
changed. Archived service accounts cannot be updated; this returns 400.
Setting `organization_role` to `admin` (even when unchanged) requires an
interactive credential (a user OAuth token or a Console session).
## Path parameters
- `service_account_id: string`
ID of the service account to update.
## Body parameters
- `description: optional string or null`
Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
maxLength: 2000
- `organization_role: optional "admin" or "developer" or null`
Replaces the org-level role. Omit or send `null` to leave unchanged.
- `"admin"`
- `"developer"`
## Returns
- `ServiceAccount object`
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on
whatever references it (federation rules).
- `type: "service_account"`
default: service_account
- `id: string`
Tagged ID of the service account.
- `archived_at: string or null`
If set, this service account is archived.
format: date-time
- `archived_by_actor_id: string or null`
Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
- `created_at: string`
When this service account was created.
format: date-time
- `created_by_actor_id: string or null`
Tagged ID (`user_`/`svac_`) of the actor that created this service account.
- `description: string or null`
Optional free-text description.
- `name: string`
Admin-chosen slug identifier.
- `organization_role: "admin" or "developer"`
Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console.
- `"admin"`
- `"developer"`
- `updated_at: string`
When this service account was last updated.
format: date-time
- `updated_by_actor_id: string or null`
Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
### Response (200)
```json
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
api/organization/service_accounts/workspaces New page · 294 lines, new page
# Workspaces ## Add Workspace To Service Account ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## List Workspaces For Service Account ### Path parameters ### Query parameters ### Returns ### Example #### Response (200) ## Remove Workspace From Service Account ### Path parameters ### Returns ### Example #### Response (200) ## Domain types ### Workspace Remove Response
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Workspaces
url: https://platform.claude.com/docs/en/api/organization/service_accounts/workspaces
---
# Workspaces
## Add Workspace To Service Account
**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Add a service account to a workspace with the given `workspace_role`.
Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from the service-account side; both create the same membership. If the
service account is already an explicit member of the workspace, its
`workspace_role` is replaced with the value supplied here. Archived
workspaces return 400. Archived service accounts cannot be added and are
rejected.
### Path parameters
- `service_account_id: string`
ID of the service account.
### Body parameters
- `workspace_id: string`
Tagged workspace ID to add the service account to.
- `workspace_role: NoBillingWorkspaceRole`
Role to assign to the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `ServiceAccountWorkspaceMember object`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```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' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}'
```
#### Response (200)
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
## List Workspaces For Service Account
**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
List the workspaces a service account is a member of.
Each entry includes the service account's `workspace_role` in that
workspace. Use `limit` and the `next_page` cursor to paginate. When the
service account has no explicit default-workspace membership, the
implicit (`implicit: true`) membership is returned as the first entry on
the first page; with `limit=1` the first page may return up to 2 entries
(the implicit entry plus one explicit membership) so a pagination cursor
can be derived. Memberships are returned only while
the service account is active. Without a `page` cursor, an archived
service account returns an empty list. A `page` cursor that does not
match an active membership returns a 400 invalid-request error. A cursor
stops matching when the membership is removed, the workspace is deleted,
or the service account is archived. Restart pagination from the first
page to recover.
### Path parameters
- `service_account_id: string`
ID of the service account.
### Query parameters
- `limit: optional number`
Number of results per page.
default: 20, minimum: 1, maximum: 100
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Returns
- `data: array of ServiceAccountWorkspaceMember`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `next_page: string or null`
Opaque cursor for the next page, or null if no more results.
### Example
```bash
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
## Remove Workspace From Service Account
**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Remove a service account from a workspace.
Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
addressed from the service-account side. Removal is idempotent (returns
200 even if the membership was already removed). A DELETE against the
implicit default-workspace membership returns 200 but is a no-op and the
membership persists; deleting an explicit default-workspace row reverts
to the implicit `workspace_user` membership. Archived workspaces return
400.
### Path parameters
- `service_account_id: string`
ID of the service account.
- `workspace_id: string`
ID of the workspace.
### Returns
- `type: "service_account_workspace_member_deleted"`
default: service_account_workspace_member_deleted
- `service_account_id: string`
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`) named in the delete request.
### Example
```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 "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
## Domain types
### Workspace Remove Response
- `WorkspaceRemoveResponse object`
- `type: "service_account_workspace_member_deleted"`
default: service_account_workspace_member_deleted
- `service_account_id: string`
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`) named in the delete request.
api/organization/service_accounts/workspaces/add New page · 107 lines, new page
# Add Workspace To Service Account ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Add Workspace To Service Account
url: https://platform.claude.com/docs/en/api/organization/service_accounts/workspaces/add
---
# Add Workspace To Service Account
**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Add a service account to a workspace with the given `workspace_role`.
Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from the service-account side; both create the same membership. If the
service account is already an explicit member of the workspace, its
`workspace_role` is replaced with the value supplied here. Archived
workspaces return 400. Archived service accounts cannot be added and are
rejected.
## Path parameters
- `service_account_id: string`
ID of the service account.
## Body parameters
- `workspace_id: string`
Tagged workspace ID to add the service account to.
- `workspace_role: NoBillingWorkspaceRole`
Role to assign to the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Returns
- `ServiceAccountWorkspaceMember object`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Example
```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' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}'
```
### Response (200)
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
api/organization/service_accounts/workspaces/list New page · 112 lines, new page
# List Workspaces For Service Account ## Path parameters ## Query parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Workspaces For Service Account
url: https://platform.claude.com/docs/en/api/organization/service_accounts/workspaces/list
---
# List Workspaces For Service Account
**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
List the workspaces a service account is a member of.
Each entry includes the service account's `workspace_role` in that
workspace. Use `limit` and the `next_page` cursor to paginate. When the
service account has no explicit default-workspace membership, the
implicit (`implicit: true`) membership is returned as the first entry on
the first page; with `limit=1` the first page may return up to 2 entries
(the implicit entry plus one explicit membership) so a pagination cursor
can be derived. Memberships are returned only while
the service account is active. Without a `page` cursor, an archived
service account returns an empty list. A `page` cursor that does not
match an active membership returns a 400 invalid-request error. A cursor
stops matching when the membership is removed, the workspace is deleted,
or the service account is archived. Restart pagination from the first
page to recover.
## Path parameters
- `service_account_id: string`
ID of the service account.
## Query parameters
- `limit: optional number`
Number of results per page.
default: 20, minimum: 1, maximum: 100
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
## Returns
- `data: array of ServiceAccountWorkspaceMember`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `next_page: string or null`
Opaque cursor for the next page, or null if no more results.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
api/organization/service_accounts/workspaces/remove New page · 63 lines, new page
# Remove Workspace From Service Account ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Remove Workspace From Service Account
url: https://platform.claude.com/docs/en/api/organization/service_accounts/workspaces/remove
---
# Remove Workspace From Service Account
**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Remove a service account from a workspace.
Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
addressed from the service-account side. Removal is idempotent (returns
200 even if the membership was already removed). A DELETE against the
implicit default-workspace membership returns 200 but is a no-op and the
membership persists; deleting an explicit default-workspace row reverts
to the implicit `workspace_user` membership. Archived workspaces return
400.
## Path parameters
- `service_account_id: string`
ID of the service account.
- `workspace_id: string`
ID of the workspace.
## Returns
- `type: "service_account_workspace_member_deleted"`
default: service_account_workspace_member_deleted
- `service_account_id: string`
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`) named in the delete request.
## Example
```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 "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
api/organization/users New page · 440 lines, new page
# Users ## List Users ### Query parameters ### Returns ### Example #### Response (200) ## Get User ### Path parameters ### Returns ### Example #### Response (200) ## Update User ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## Remove User ### Path parameters ### Returns ### Example #### Response (200) ## Domain types ### Organization User ### User Remove Response
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Users
url: https://platform.claude.com/docs/en/api/organization/users
---
# Users
## List Users
**GET** `/v1/organizations/users`
List the organization's members.
### Query parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `email: optional string`
Filter by user email.
format: email
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default: 20, minimum: 1, maximum: 1000
- `roles: optional array of string`
Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
### Returns
- `data: array of OrganizationUser`
- `type: "user"`
Object type.
For Users, this is always `"user"`.
default: user
- `id: string`
ID of the User.
- `added_at: string`
RFC 3339 datetime string indicating when the User joined the Organization.
format: date-time
- `email: string`
Email of the User.
- `name: string`
Name of the User.
- `role: OrganizationRole`
Organization role of the User.
- `"admin"`
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"membership_admin"`
- `"owner"`
- `"primary_owner"`
- `"user"`
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
### Example
```bash
curl https://api.anthropic.com/v1/organizations/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "[email protected]",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
## Get User
**GET** `/v1/organizations/users/{user_id}`
Retrieve a member of the organization by user ID.
### Path parameters
- `user_id: string`
ID of the User.
### Returns
- `OrganizationUser object`
- `type: "user"`
Object type.
For Users, this is always `"user"`.
default: user
- `id: string`
ID of the User.
- `added_at: string`
RFC 3339 datetime string indicating when the User joined the Organization.
format: date-time
- `email: string`
Email of the User.
- `name: string`
Name of the User.
- `role: OrganizationRole`
Organization role of the User.
- `"admin"`
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"membership_admin"`
- `"owner"`
- `"primary_owner"`
- `"user"`
### Example
```bash
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "[email protected]",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
```
## Update User
**POST** `/v1/organizations/users/{user_id}`
Update a member's organization role.
### Path parameters
- `user_id: string`
ID of the User.
### Body parameters
- `role: "billing" or "claude_code_user" or "developer" or 2 more`
New role for the User.
The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"user"`
### Returns
- `OrganizationUser object`
- `type: "user"`
Object type.
For Users, this is always `"user"`.
default: user
- `id: string`
ID of the User.
- `added_at: string`
RFC 3339 datetime string indicating when the User joined the Organization.
format: date-time
- `email: string`
Email of the User.
- `name: string`
Name of the User.
- `role: OrganizationRole`
Organization role of the User.
- `"admin"`
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"membership_admin"`
- `"owner"`
- `"primary_owner"`
Cut at 300 lines. The page has the rest.
api/organization/users/list New page · 132 lines, new page
# List Users ## Query parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Users
url: https://platform.claude.com/docs/en/api/organization/users/list
---
# List Users
**GET** `/v1/organizations/users`
List the organization's members.
## Query parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `email: optional string`
Filter by user email.
format: email
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default: 20, minimum: 1, maximum: 1000
- `roles: optional array of string`
Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
## Returns
- `data: array of OrganizationUser`
- `type: "user"`
Object type.
For Users, this is always `"user"`.
default: user
- `id: string`
ID of the User.
- `added_at: string`
RFC 3339 datetime string indicating when the User joined the Organization.
format: date-time
- `email: string`
Email of the User.
- `name: string`
Name of the User.
- `role: OrganizationRole`
Organization role of the User.
- `"admin"`
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"membership_admin"`
- `"owner"`
- `"primary_owner"`
- `"user"`
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "[email protected]",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
api/organization/users/remove New page · 48 lines, new page
# Remove User ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Remove User
url: https://platform.claude.com/docs/en/api/organization/users/remove
---
# Remove User
**DELETE** `/v1/organizations/users/{user_id}`
Remove a member from the organization.
## Path parameters
- `user_id: string`
ID of the User.
## Returns
- `type: "user_deleted"`
Deleted object type.
For Users, this is always `"user_deleted"`.
default: user_deleted
- `id: string`
ID of the User.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user_deleted"
}
```
api/organization/users/retrieve New page · 89 lines, new page
# Get User ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Get User
url: https://platform.claude.com/docs/en/api/organization/users/retrieve
---
# Get User
**GET** `/v1/organizations/users/{user_id}`
Retrieve a member of the organization by user ID.
## Path parameters
- `user_id: string`
ID of the User.
## Returns
- `OrganizationUser object`
- `type: "user"`
Object type.
For Users, this is always `"user"`.
default: user
- `id: string`
ID of the User.
- `added_at: string`
RFC 3339 datetime string indicating when the User joined the Organization.
format: date-time
- `email: string`
Email of the User.
- `name: string`
Name of the User.
- `role: OrganizationRole`
Organization role of the User.
- `"admin"`
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"membership_admin"`
- `"owner"`
- `"primary_owner"`
- `"user"`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "[email protected]",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
```
api/organization/users/update New page · 111 lines, new page
# Update User ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Update User
url: https://platform.claude.com/docs/en/api/organization/users/update
---
# Update User
**POST** `/v1/organizations/users/{user_id}`
Update a member's organization role.
## Path parameters
- `user_id: string`
ID of the User.
## Body parameters
- `role: "billing" or "claude_code_user" or "developer" or 2 more`
New role for the User.
The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"user"`
## Returns
- `OrganizationUser object`
- `type: "user"`
Object type.
For Users, this is always `"user"`.
default: user
- `id: string`
ID of the User.
- `added_at: string`
RFC 3339 datetime string indicating when the User joined the Organization.
format: date-time
- `email: string`
Email of the User.
- `name: string`
Name of the User.
- `role: OrganizationRole`
Organization role of the User.
- `"admin"`
- `"billing"`
- `"claude_code_user"`
- `"developer"`
- `"managed"`
- `"membership_admin"`
- `"owner"`
- `"primary_owner"`
- `"user"`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"role": "user"
}'
```
### Response (200)
```json
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "[email protected]",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
```
api/organization/workspaces New page · 2233 lines, new page
# Workspaces ## List Workspaces ### Query parameters ### Returns ### Example #### Response (200) ## Create Workspace ### Body parameters ### Returns ### Example #### Response (200) ## Get Workspace ### Path parameters ### Returns ### Example #### Response (200) ## Update Workspace ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## Archive Workspace ### Path parameters ### Returns ### Example #### Response (200) ## Domain types ### Allowed Inference Geo ### Data Residency ### Data Residency Create Config ### Data Residency Update Config ### No Billing Workspace Role ### Workspace ### Workspace Member ### Workspace Role ## Workspaces › Rate Limits ### List Workspace Rate Limits #### Path parameters #### Query parameters #### Returns #### Example ##### Response (200) ## Workspaces › Members ### List Workspace Members #### Path parameters #### Query parameters #### Returns #### Example ##### Response (200) ### Create Workspace Member #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Get Workspace Member #### Path parameters #### Returns #### Example ##### Response (200) ### Update Workspace Member #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Delete Workspace Member #### Path parameters #### Returns #### Example ##### Response (200) ## Workspaces › Service Accounts ### List Service Account Workspace Members #### Path parameters #### Query parameters #### Returns #### Example ##### Response (200) ### Create Service Account Workspace Member #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Get Service Account Workspace Member #### Path parameters #### Returns #### Example ##### Response (200) ### Update Service Account Workspace Member #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Delete Service Account Workspace Member #### Path parameters #### Returns #### Example ##### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Workspaces
url: https://platform.claude.com/docs/en/api/organization/workspaces
---
# Workspaces
## List Workspaces
**GET** `/v1/organizations/workspaces`
List Workspaces
### Query parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `include_archived: optional boolean`
Whether to include Workspaces that have been archived in the response
default: false
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default: 20, minimum: 1, maximum: 1000
### Returns
- `data: array of Workspace`
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
default: workspace
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
format: date-time
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK
integration guide for the required key configuration; unless your organization
is on Claude Platform on AWS, it includes a separate value used during key
validation. On Claude Platform on AWS there is no separate validation value:
the key is validated against this Workspace's own value when it is attached, so
if your key policy uses the compartment condition, add this value to it before
attaching the key.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
format: date-time
- `data_residency: DataResidency`
Data residency configuration.
- `allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: "global" or "us"`
Default inference geo applied when requests omit the parameter.
- `"global"`
- `"us"`
- `workspace_geo: "us"`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
## Create Workspace
**POST** `/v1/organizations/workspaces`
Create Workspace
### Body parameters
- `name: string`
Name of the Workspace.
minLength: 1, maxLength: 40
- `data_residency: optional DataResidencyCreateConfig or null`
Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`.
- `allowed_inference_geos: optional array of AllowedInferenceGeo or "unrestricted" or null`
Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: optional "global" or "us" or null`
Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
- `"global"`
- `"us"`
- `workspace_geo: optional "us" or null`
Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
- `display_color: optional string or null`
Hex color code representing the Workspace in the Anthropic Console.
maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
- `external_key_id: optional string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `tags: optional map[string] or null`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
### Returns
- `Workspace object`
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
default: workspace
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
format: date-time
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK
integration guide for the required key configuration; unless your organization
is on Claude Platform on AWS, it includes a separate value used during key
validation. On Claude Platform on AWS there is no separate validation value:
the key is validated against this Workspace's own value when it is attached, so
if your key policy uses the compartment condition, add this value to it before
attaching the key.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
format: date-time
- `data_residency: DataResidency`
Data residency configuration.
- `allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
Cut at 300 lines. The page has the rest.
api/organization/workspaces/archive New page · 143 lines, new page
# Archive Workspace ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Archive Workspace
url: https://platform.claude.com/docs/en/api/organization/workspaces/archive
---
# Archive Workspace
**POST** `/v1/organizations/workspaces/{workspace_id}/archive`
Archive Workspace
## Path parameters
- `workspace_id: string`
## Returns
- `Workspace object`
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
default: workspace
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
format: date-time
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK
integration guide for the required key configuration; unless your organization
is on Claude Platform on AWS, it includes a separate value used during key
validation. On Claude Platform on AWS there is no separate validation value:
the key is validated against this Workspace's own value when it is attached, so
if your key policy uses the compartment condition, add this value to it before
attaching the key.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
format: date-time
- `data_residency: DataResidency`
Data residency configuration.
- `allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: "global" or "us"`
Default inference geo applied when requests omit the parameter.
- `"global"`
- `"us"`
- `workspace_geo: "us"`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
api/organization/workspaces/create New page · 208 lines, new page
# Create Workspace ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Create Workspace
url: https://platform.claude.com/docs/en/api/organization/workspaces/create
---
# Create Workspace
**POST** `/v1/organizations/workspaces`
Create Workspace
## Body parameters
- `name: string`
Name of the Workspace.
minLength: 1, maxLength: 40
- `data_residency: optional DataResidencyCreateConfig or null`
Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`.
- `allowed_inference_geos: optional array of AllowedInferenceGeo or "unrestricted" or null`
Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: optional "global" or "us" or null`
Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
- `"global"`
- `"us"`
- `workspace_geo: optional "us" or null`
Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
- `display_color: optional string or null`
Hex color code representing the Workspace in the Anthropic Console.
maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
- `external_key_id: optional string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `tags: optional map[string] or null`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
## Returns
- `Workspace object`
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
default: workspace
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
format: date-time
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK
integration guide for the required key configuration; unless your organization
is on Claude Platform on AWS, it includes a separate value used during key
validation. On Claude Platform on AWS there is no separate validation value:
the key is validated against this Workspace's own value when it is attached, so
if your key policy uses the compartment condition, add this value to it before
attaching the key.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
format: date-time
- `data_residency: DataResidency`
Data residency configuration.
- `allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: "global" or "us"`
Default inference geo applied when requests omit the parameter.
- `"global"`
- `"us"`
- `workspace_geo: "us"`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "x",
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"tags": {
"env": "prod",
"team": "platform"
}
}'
```
### Response (200)
```json
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
api/organization/workspaces/list New page · 181 lines, new page
# List Workspaces ## Query parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Workspaces
url: https://platform.claude.com/docs/en/api/organization/workspaces/list
---
# List Workspaces
**GET** `/v1/organizations/workspaces`
List Workspaces
## Query parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `include_archived: optional boolean`
Whether to include Workspaces that have been archived in the response
default: false
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default: 20, minimum: 1, maximum: 1000
## Returns
- `data: array of Workspace`
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
default: workspace
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
format: date-time
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK
integration guide for the required key configuration; unless your organization
is on Claude Platform on AWS, it includes a separate value used during key
validation. On Claude Platform on AWS there is no separate validation value:
the key is validated against this Workspace's own value when it is attached, so
if your key policy uses the compartment condition, add this value to it before
attaching the key.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
format: date-time
- `data_residency: DataResidency`
Data residency configuration.
- `allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: "global" or "us"`
Default inference geo applied when requests omit the parameter.
- `"global"`
- `"us"`
- `workspace_geo: "us"`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"data": [
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
api/organization/workspaces/members New page · 429 lines, new page
# Members ## List Workspace Members ### Path parameters ### Query parameters ### Returns ### Example #### Response (200) ## Create Workspace Member ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## Get Workspace Member ### Path parameters ### Returns ### Example #### Response (200) ## Update Workspace Member ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## Delete Workspace Member ### Path parameters ### Returns ### Example #### Response (200) ## Domain types ### Member Remove Response
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Members
url: https://platform.claude.com/docs/en/api/organization/workspaces/members
---
# Members
## List Workspace Members
**GET** `/v1/organizations/workspaces/{workspace_id}/members`
List Workspace Members
### Path parameters
- `workspace_id: string`
ID of the Workspace.
### Query parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default: 20, minimum: 1, maximum: 1000
### Returns
- `data: array of WorkspaceMember`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
## Create Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/members`
Create Workspace Member
### Path parameters
- `workspace_id: string`
ID of the Workspace.
### Body parameters
- `user_id: string`
ID of the User.
- `workspace_role: NoBillingWorkspaceRole`
Role of the new Workspace Member. Cannot be `workspace_billing`.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `WorkspaceMember object`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_role": "workspace_admin"
}'
```
#### Response (200)
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
## Get Workspace Member
**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Get Workspace Member
### Path parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
### Returns
- `WorkspaceMember object`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
## Update Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Update Workspace Member
### Path parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
### Body parameters
- `workspace_role: WorkspaceRole`
New workspace role for the User.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
Cut at 300 lines. The page has the rest.
api/organization/workspaces/members/add New page · 92 lines, new page
# Create Workspace Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Create Workspace Member
url: https://platform.claude.com/docs/en/api/organization/workspaces/members/add
---
# Create Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/members`
Create Workspace Member
## Path parameters
- `workspace_id: string`
ID of the Workspace.
## Body parameters
- `user_id: string`
ID of the User.
- `workspace_role: NoBillingWorkspaceRole`
Role of the new Workspace Member. Cannot be `workspace_billing`.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Returns
- `WorkspaceMember object`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_role": "workspace_admin"
}'
```
### Response (200)
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
api/organization/workspaces/members/list New page · 106 lines, new page
# List Workspace Members ## Path parameters ## Query parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Workspace Members
url: https://platform.claude.com/docs/en/api/organization/workspaces/members/list
---
# List Workspace Members
**GET** `/v1/organizations/workspaces/{workspace_id}/members`
List Workspace Members
## Path parameters
- `workspace_id: string`
ID of the Workspace.
## Query parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default: 20, minimum: 1, maximum: 1000
## Returns
- `data: array of WorkspaceMember`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
api/organization/workspaces/members/remove New page · 57 lines, new page
# Delete Workspace Member ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Delete Workspace Member
url: https://platform.claude.com/docs/en/api/organization/workspaces/members/remove
---
# Delete Workspace Member
**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Delete Workspace Member
## Path parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
## Returns
- `type: "workspace_member_deleted"`
Deleted object type.
For Workspace Members, this is always `"workspace_member_deleted"`.
default: workspace_member_deleted
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"type": "workspace_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
api/organization/workspaces/members/retrieve New page · 73 lines, new page
# Get Workspace Member ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Get Workspace Member
url: https://platform.claude.com/docs/en/api/organization/workspaces/members/retrieve
---
# Get Workspace Member
**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Get Workspace Member
## Path parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
## Returns
- `WorkspaceMember object`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
api/organization/workspaces/members/update New page · 93 lines, new page
# Update Workspace Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Update Workspace Member
url: https://platform.claude.com/docs/en/api/organization/workspaces/members/update
---
# Update Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Update Workspace Member
## Path parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
## Body parameters
- `workspace_role: WorkspaceRole`
New workspace role for the User.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Returns
- `WorkspaceMember object`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
default: workspace_member
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: WorkspaceRole`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_role": "workspace_admin"
}'
```
### Response (200)
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
api/organization/workspaces/rate_limits New page · 482 lines, new page
# Rate Limits ## List Workspace Rate Limits ### Path parameters ### Query parameters ### Returns ### Example #### Response (200) ## Domain types ### Workspace Rate Limit ### Workspace Rate Limit Organization Source ### Workspace Rate Limit Value ### Workspace Rate Limit Workspace Source
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Rate Limits
url: https://platform.claude.com/docs/en/api/organization/workspaces/rate_limits
---
# Rate Limits
## List Workspace Rate Limits
**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits`
List a workspace's rate limits.
By default, returns only the groups and limiter types that have a
workspace-level override. With `include_inherited=true`, returns every
group with organization-level limits the workspace can see, listing for
each the values it inherits from the organization as well as its own
overrides. Each value's `source` says which it is.
When `limit` is omitted, every matching entry is returned in a single
page; when `limit` truncates the result, follow `next_page` to fetch
the remaining entries.
### Path parameters
- `workspace_id: string`
The ID of the workspace.
### Query parameters
- `group_type: optional "batch" or "files" or "model_group" or 3 more`
Filter by group type.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `include_inherited: optional boolean`
Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.
default: false
- `limit: optional number`
Maximum number of items to return per page. Ranges from `1` to `1000`.
When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
minimum: 1, maximum: 1000
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Returns
- `data: array of WorkspaceRateLimit`
Rate-limit entries for the workspace: one per group with at least one override, or, with `include_inherited` set to `true`, one per group the workspace can see that has organization-level limits.
- `type: "workspace_rate_limit"`
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
default: workspace_rate_limit
- `group: OrganizationRateLimitModelGroup or OrganizationRateLimitBatchGroup or OrganizationRateLimitTokenCountGroup or 3 more`
The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
- `OrganizationRateLimitModelGroup object`
- `type: "model_group"`
Always `model_group`: a family of models.
default: model_group
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `display_name: string`
Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
- `OrganizationRateLimitBatchGroup object`
- `type: "batch"`
Always `batch`: the Message Batches API.
default: batch
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitTokenCountGroup object`
- `type: "token_count"`
Always `token_count`: the Token Count API.
default: token_count
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitFilesGroup object`
- `type: "files"`
Always `files`: the Files API.
default: files
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitSkillsGroup object`
- `type: "skills"`
Always `skills`: the Skills API.
default: skills
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitWebSearchGroup object`
- `type: "web_search"`
Always `web_search`: the Messages API web search tool.
default: web_search
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `limits: array of WorkspaceRateLimitValue`
The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With `include_inherited` set to `true`, the limiter types the workspace inherits from the organization are listed too, each marked by `source`.
- `type: string`
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
- `org_limit: number or null`
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
- `source: WorkspaceRateLimitWorkspaceSource or WorkspaceRateLimitOrganizationSource`
Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`.
- `WorkspaceRateLimitWorkspaceSource object`
- `type: "workspace"`
Always `workspace`: a workspace-level override is stored.
default: workspace
- `WorkspaceRateLimitOrganizationSource object`
- `type: "organization"`
Always `organization`: no workspace-level override is stored, so the organization's value applies.
default: organization
- `value: number`
The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value.
- `models: array of string or null`
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
- `rate_limit_id: string`
The `id` of the organization's RateLimit entry this entry applies to.
- `workspace_id: string`
ID of the Workspace this entry applies to.
- `group_type: "batch" or "files" or "model_group" or 3 more`
**Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `next_page: string or null`
Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"source": {
"type": "workspace"
},
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
## Domain types
### Workspace Rate Limit
- `WorkspaceRateLimit object`
- `type: "workspace_rate_limit"`
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
default: workspace_rate_limit
- `group: OrganizationRateLimitModelGroup or OrganizationRateLimitBatchGroup or OrganizationRateLimitTokenCountGroup or 3 more`
The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
- `OrganizationRateLimitModelGroup object`
- `type: "model_group"`
Always `model_group`: a family of models.
default: model_group
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `display_name: string`
Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
Cut at 300 lines. The page has the rest.
api/organization/workspaces/rate_limits/list New page · 266 lines, new page
# List Workspace Rate Limits ## Path parameters ## Query parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Workspace Rate Limits
url: https://platform.claude.com/docs/en/api/organization/workspaces/rate_limits/list
---
# List Workspace Rate Limits
**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits`
List a workspace's rate limits.
By default, returns only the groups and limiter types that have a
workspace-level override. With `include_inherited=true`, returns every
group with organization-level limits the workspace can see, listing for
each the values it inherits from the organization as well as its own
overrides. Each value's `source` says which it is.
When `limit` is omitted, every matching entry is returned in a single
page; when `limit` truncates the result, follow `next_page` to fetch
the remaining entries.
## Path parameters
- `workspace_id: string`
The ID of the workspace.
## Query parameters
- `group_type: optional "batch" or "files" or "model_group" or 3 more`
Filter by group type.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `include_inherited: optional boolean`
Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.
default: false
- `limit: optional number`
Maximum number of items to return per page. Ranges from `1` to `1000`.
When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
minimum: 1, maximum: 1000
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
## Returns
- `data: array of WorkspaceRateLimit`
Rate-limit entries for the workspace: one per group with at least one override, or, with `include_inherited` set to `true`, one per group the workspace can see that has organization-level limits.
- `type: "workspace_rate_limit"`
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
default: workspace_rate_limit
- `group: OrganizationRateLimitModelGroup or OrganizationRateLimitBatchGroup or OrganizationRateLimitTokenCountGroup or 3 more`
The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
- `OrganizationRateLimitModelGroup object`
- `type: "model_group"`
Always `model_group`: a family of models.
default: model_group
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `display_name: string`
Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
- `OrganizationRateLimitBatchGroup object`
- `type: "batch"`
Always `batch`: the Message Batches API.
default: batch
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitTokenCountGroup object`
- `type: "token_count"`
Always `token_count`: the Token Count API.
default: token_count
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitFilesGroup object`
- `type: "files"`
Always `files`: the Files API.
default: files
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitSkillsGroup object`
- `type: "skills"`
Always `skills`: the Skills API.
default: skills
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `OrganizationRateLimitWebSearchGroup object`
- `type: "web_search"`
Always `web_search`: the Messages API web search tool.
default: web_search
- `id: string`
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
- `limits: array of WorkspaceRateLimitValue`
The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With `include_inherited` set to `true`, the limiter types the workspace inherits from the organization are listed too, each marked by `source`.
- `type: string`
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
- `org_limit: number or null`
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
- `source: WorkspaceRateLimitWorkspaceSource or WorkspaceRateLimitOrganizationSource`
Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`.
- `WorkspaceRateLimitWorkspaceSource object`
- `type: "workspace"`
Always `workspace`: a workspace-level override is stored.
default: workspace
- `WorkspaceRateLimitOrganizationSource object`
- `type: "organization"`
Always `organization`: no workspace-level override is stored, so the organization's value applies.
default: organization
- `value: number`
The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value.
- `models: array of string or null`
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
- `rate_limit_id: string`
The `id` of the organization's RateLimit entry this entry applies to.
- `workspace_id: string`
ID of the Workspace this entry applies to.
- `group_type: "batch" or "files" or "model_group" or 3 more`
**Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `next_page: string or null`
Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"data": [
{
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"source": {
"type": "workspace"
},
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
api/organization/workspaces/retrieve New page · 144 lines, new page
# Get Workspace ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Get Workspace
url: https://platform.claude.com/docs/en/api/organization/workspaces/retrieve
---
# Get Workspace
**GET** `/v1/organizations/workspaces/{workspace_id}`
Get Workspace
## Path parameters
- `workspace_id: string`
ID of the Workspace.
## Returns
- `Workspace object`
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
default: workspace
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
format: date-time
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK
integration guide for the required key configuration; unless your organization
is on Claude Platform on AWS, it includes a separate value used during key
validation. On Claude Platform on AWS there is no separate validation value:
the key is validated against this Workspace's own value when it is attached, so
if your key policy uses the compartment condition, add this value to it before
attaching the key.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
format: date-time
- `data_residency: DataResidency`
Data residency configuration.
- `allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `Geos = array of AllowedInferenceGeo`
- `"global"`
- `"us"`
- `"unrestricted"`
- `default_inference_geo: "global" or "us"`
Default inference geo applied when requests omit the parameter.
- `"global"`
- `"us"`
- `workspace_geo: "us"`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. On
Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
single-Region key in the same AWS account and Region as the Workspace. On that
platform the key is validated against this Workspace when it is attached, so a
key-policy problem is reported as an error on this request. This field is write-once:
once a key is attached to a Workspace it cannot be detached or replaced. To
rotate key material, rotate the underlying key on your cloud KMS; the
`external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
api/organization/workspaces/service_accounts New page · 473 lines, new page
# Service Accounts ## List Service Account Workspace Members ### Path parameters ### Query parameters ### Returns ### Example #### Response (200) ## Create Service Account Workspace Member ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## Get Service Account Workspace Member ### Path parameters ### Returns ### Example #### Response (200) ## Update Service Account Workspace Member ### Path parameters ### Body parameters ### Returns ### Example #### Response (200) ## Delete Service Account Workspace Member ### Path parameters ### Returns ### Example #### Response (200) ## Domain types ### Service Account Remove Response
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Service Accounts
url: https://platform.claude.com/docs/en/api/organization/workspaces/service_accounts
---
# Service Accounts
## List Service Account Workspace Members
**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
List the service accounts that are members of a workspace.
Each entry includes the service account's `workspace_role`. Use `limit`
and the `next_page` cursor to paginate. Archived workspaces return 400;
use `GET /service_accounts/{id}/workspaces` to audit memberships of an
archived workspace. The implicit default-workspace membership is not
included in this list. Memberships of archived service accounts are
omitted from the results.
### Path parameters
- `workspace_id: string`
ID of the workspace.
### Query parameters
- `limit: optional number`
Number of results per page.
default: 20, minimum: 1, maximum: 100
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Returns
- `data: array of ServiceAccountWorkspaceMember`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `next_page: string or null`
Opaque cursor for the next page, or null if no more results.
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
## Create Service Account Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Add a service account to a workspace with the given `workspace_role`.
The role determines what the service account can do in the workspace and
which workspace-scoped permissions it can be granted when authenticating
through federation. Every service account is already an implicit
`workspace_user` member of the default workspace; adding it explicitly
assigns a chosen role. If the service account is already an explicit
member of the workspace, its `workspace_role` is replaced with the
value supplied here. Archived workspaces return 400. Archived service
accounts cannot be added and are rejected.
### Path parameters
- `workspace_id: string`
ID of the workspace.
### Body parameters
- `service_account_id: string`
Tagged service account ID to add.
- `workspace_role: NoBillingWorkspaceRole`
Role to assign to the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `ServiceAccountWorkspaceMember object`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"service_account_id": "service_account_id",
"workspace_role": "workspace_admin"
}'
```
#### Response (200)
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
## Get Service Account Workspace Member
**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Retrieve a service account's membership in a workspace.
Returns the membership record, including the service account's
`workspace_role` in this workspace. Archived workspaces return 400. For
the default workspace, returns the implicit (`implicit: true`)
membership when no explicit membership exists; an explicitly added
membership is returned with its assigned role. An archived service
account returns 404.
### Path parameters
- `workspace_id: string`
ID of the workspace.
- `service_account_id: string`
ID of the service account.
### Returns
- `ServiceAccountWorkspaceMember object`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response (200)
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
## Update Service Account Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
Cut at 300 lines. The page has the rest.
api/organization/workspaces/service_accounts/add New page · 109 lines, new page
# Create Service Account Workspace Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Create Service Account Workspace Member
url: https://platform.claude.com/docs/en/api/organization/workspaces/service_accounts/add
---
# Create Service Account Workspace Member
**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
Add a service account to a workspace with the given `workspace_role`.
The role determines what the service account can do in the workspace and
which workspace-scoped permissions it can be granted when authenticating
through federation. Every service account is already an implicit
`workspace_user` member of the default workspace; adding it explicitly
assigns a chosen role. If the service account is already an explicit
member of the workspace, its `workspace_role` is replaced with the
value supplied here. Archived workspaces return 400. Archived service
accounts cannot be added and are rejected.
## Path parameters
- `workspace_id: string`
ID of the workspace.
## Body parameters
- `service_account_id: string`
Tagged service account ID to add.
- `workspace_role: NoBillingWorkspaceRole`
Role to assign to the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Returns
- `ServiceAccountWorkspaceMember object`
- `type: "service_account_workspace_member"`
default: service_account_workspace_member
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: WorkspaceRole`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"service_account_id": "service_account_id",
"workspace_role": "workspace_admin"
}'
```
### Response (200)
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```