What this read moved
26–50 of 122This capture is too large to show at once. Changes 26-50 of 122 are below, significant first; the rest are on the following screens.
api/admin/invites Changed · +4 / -4 lines
from line 120
120120curl https://api.anthropic.com/v1/organizations/invites \
121121 -H 'Content-Type: application/json' \
122122 -H 'anthropic-version: 2023-06-01' \
123 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
123 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
124124 -d '{
126126 "role": "user"
from line 238
238238```bash
239239curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
240240 -H 'anthropic-version: 2023-06-01' \
241 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
241 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
242242```
243243
244244#### Response (200)
from line 398
398398```bash
399399curl https://api.anthropic.com/v1/organizations/invites \
400400 -H 'anthropic-version: 2023-06-01' \
401 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
401 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
402402```
403403
404404#### Response (200)
from line 458
458458curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
459459 -X DELETE \
460460 -H 'anthropic-version: 2023-06-01' \
461 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
461 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
462462```
463463
464464#### Response (200)
api/admin/mcp_tunnels Changed · +9 / -9 lines
from line 67
6767```bash
6868curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID \
6969 -H 'anthropic-version: 2023-06-01' \
70 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
70 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
7171```
7272
7373#### Response (200)
from line 180
180180```bash
181181curl https://api.anthropic.com/v1/organizations/tunnels \
182182 -H 'anthropic-version: 2023-06-01' \
183 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
183 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
184184```
185185
186186#### Response (200)
from line 252
252252curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/reveal_token \
253253 -X POST \
254254 -H 'anthropic-version: 2023-06-01' \
255 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
255 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
256256```
257257
258258#### Response (200)
from line 322
322322curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/rotate_token \
323323 -X POST \
324324 -H 'anthropic-version: 2023-06-01' \
325 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
325 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
326326```
327327
328328#### Response (200)
from line 408
408408curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/archive \
409409 -X POST \
410410 -H 'anthropic-version: 2023-06-01' \
411 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
411 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
412412```
413413
414414#### Response (200)
from line 675
675675curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
676676 -H 'Content-Type: application/json' \
677677 -H 'anthropic-version: 2023-06-01' \
678 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
678 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
679679 -d '{
680680 "ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n"
681681 }'
from line 766
766766```bash
767767curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
768768 -H 'anthropic-version: 2023-06-01' \
769 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
769 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
770770```
771771
772772##### Response (200)
from line 878
878878```bash
879879curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
880880 -H 'anthropic-version: 2023-06-01' \
881 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
881 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
882882```
883883
884884##### Response (200)
from line 976
976976curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
977977 -X POST \
978978 -H 'anthropic-version: 2023-06-01' \
979 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
979 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
980980```
981981
982982##### Response (200)
api/admin/mcp_tunnels/tunnel_certificates Changed · +4 / -4 lines
from line 82
8282curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
8383 -H 'Content-Type: application/json' \
8484 -H 'anthropic-version: 2023-06-01' \
85 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
85 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
8686 -d '{
8787 "ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n"
8888 }'
from line 173
173173```bash
174174curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
175175 -H 'anthropic-version: 2023-06-01' \
176 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
176 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
177177```
178178
179179#### Response (200)
from line 285
285285```bash
286286curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
287287 -H 'anthropic-version: 2023-06-01' \
288 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
288 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
289289```
290290
291291#### Response (200)
from line 383
383383curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
384384 -X POST \
385385 -H 'anthropic-version: 2023-06-01' \
386 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
386 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
387387```
388388
389389#### Response (200)
api/admin/rate_limits Changed · +35 / -31 lines
from line 10
1010or an API-surface category such as the Files API or Message Batches)
1111and contains the set of limiter values that apply to it.
1212
13When `limit` is omitted, every matching entry is returned in a single
14page; when `limit` truncates the result, follow `next_page` to fetch
15the remaining entries.
16
1317### Query parameters
1418
1519- `group_type: optional "batch" or "files" or "model_group" or 3 more`
from line 32
2832
2933 - `"web_search"`
3034
35- `limit: optional number`
36
37 Maximum number of items to return per page. Ranges from `1` to `1000`.
38
39 When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
40
41 maximum: 1000, minimum: 1
42
3143- `model: optional string`
3244
3345 Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.
from line 98
8698
8799- `next_page: string or null`
88100
89 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
101 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
90102
91103### Example
92104
from line 105
93105```bash
94106curl https://api.anthropic.com/v1/organizations/rate_limits \
95107 -H 'anthropic-version: 2023-06-01' \
96 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
108 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
97109```
98110
99111#### Response (200)
from line 138
126138
127139- `RateLimitListResponse object`
128140
129 - `data: array of object`
141 - `id: string`
130142
131 Rate-limit entries for the organization, one per group.
143 Stable identifier for this rate-limit group within the organization.
132144
133 - `id: string`
145 - `group_type: "batch" or "files" or "model_group" or 3 more`
134146
135 Stable identifier for this rate-limit group within the organization.
147 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`.
136148
137 - `group_type: "batch" or "files" or "model_group" or 3 more`
149 - `"batch"`
138150
139 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`.
151 - `"files"`
140152
141 - `"batch"`
153 - `"model_group"`
142154
143 - `"files"`
155 - `"skills"`
144156
145 - `"model_group"`
157 - `"token_count"`
146158
147 - `"skills"`
159 - `"web_search"`
148160
149 - `"token_count"`
161 - `limits: array of object`
150162
151 - `"web_search"`
163 The limiter values that apply to this group.
152164
153 - `limits: array of object`
165 - `type: string`
154166
155 The limiter values that apply to this group.
167 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
156168
157 - `type: string`
169 - `value: number`
158170
159 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
171 The configured limit value for this limiter type.
160172
161 - `value: number`
173 - `models: array of string or null`
162174
163 The configured limit value for this limiter type.
175 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
164176
165 - `models: array of string or null`
177 - `type: "rate_limit"`
166178
167 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
179 Object type. Always `rate_limit` for organization rate-limit entries.
168180
169 - `type: "rate_limit"`
170
171 Object type. Always `rate_limit` for organization rate-limit entries.
172
173 default: rate_limit
174
175 - `next_page: string or null`
176
177 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
181 default: rate_limit
178182
api/admin/rate_limits/list Changed · +14 / -2 lines
from line 8
88or an API-surface category such as the Files API or Message Batches)
99and contains the set of limiter values that apply to it.
1010
11When `limit` is omitted, every matching entry is returned in a single
12page; when `limit` truncates the result, follow `next_page` to fetch
13the remaining entries.
14
1115## Query parameters
1216
1317- `group_type: optional "batch" or "files" or "model_group" or 3 more`
from line 30
2630
2731 - `"web_search"`
2832
33- `limit: optional number`
34
35 Maximum number of items to return per page. Ranges from `1` to `1000`.
36
37 When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
38
39 maximum: 1000, minimum: 1
40
2941- `model: optional string`
3042
3143 Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.
from line 96
8496
8597- `next_page: string or null`
8698
87 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
99 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
88100
89101## Example
90102
from line 103
91103```bash
92104curl https://api.anthropic.com/v1/organizations/rate_limits \
93105 -H 'anthropic-version: 2023-06-01' \
94 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
106 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
95107```
96108
97109### Response (200)
api/admin/rbac_groups Changed · +12 / -12 lines
from line 79
7979```bash
8080curl https://api.anthropic.com/v1/organizations/rbac_groups \
8181 -H 'anthropic-version: 2023-06-01' \
82 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
82 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
8383```
8484
8585#### Response (200)
from line 167
167167```bash
168168curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
169169 -H 'anthropic-version: 2023-06-01' \
170 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
170 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
171171```
172172
173173#### Response (200)
from line 252
252252curl https://api.anthropic.com/v1/organizations/rbac_groups \
253253 -H 'Content-Type: application/json' \
254254 -H 'anthropic-version: 2023-06-01' \
255 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
255 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
256256 -d '{
257257 "name": "Engineering"
258258 }'
from line 278
278278
279279**POST** `/v1/organizations/rbac_groups/{group_id}`
280280
281Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
281Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
282282
283283The RBAC Groups API is available to Claude Enterprise organizations only.
284284
from line 346
346346curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
347347 -H 'Content-Type: application/json' \
348348 -H 'anthropic-version: 2023-06-01' \
349 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
349 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
350350 -d '{
351351 "name": "Engineering"
352352 }'
from line 372
372372
373373**DELETE** `/v1/organizations/rbac_groups/{group_id}`
374374
375Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API.
375Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API while an organization in the tenant uses SCIM provisioning.
376376
377377The RBAC Groups API is available to Claude Enterprise organizations only.
378378
from line 404
404404curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
405405 -X DELETE \
406406 -H 'anthropic-version: 2023-06-01' \
407 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
407 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
408408```
409409
410410#### Response (200)
from line 551
551551```bash
552552curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
553553 -H 'anthropic-version: 2023-06-01' \
554 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
554 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
555555```
556556
557557##### Response (200)
from line 576
576576
577577**POST** `/v1/organizations/rbac_groups/{group_id}/members`
578578
579Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
579Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
580580
581581The RBAC Groups API is available to Claude Enterprise organizations only.
582582
from line 628
628628curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
629629 -H 'Content-Type: application/json' \
630630 -H 'anthropic-version: 2023-06-01' \
631 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
631 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
632632 -d '{
633633 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
634634 }'
from line 650
650650
651651**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
652652
653Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
653Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
654654
655655The RBAC Groups API is available to Claude Enterprise organizations only.
656656
from line 688
688688curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
689689 -X DELETE \
690690 -H 'anthropic-version: 2023-06-01' \
691 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
691 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
692692```
693693
694694##### Response (200)
api/admin/rbac_groups/members Changed · +5 / -5 lines
from line 71
7171```bash
7272curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
7373 -H 'anthropic-version: 2023-06-01' \
74 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
74 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
7575```
7676
7777#### Response (200)
from line 96
9696
9797**POST** `/v1/organizations/rbac_groups/{group_id}/members`
9898
99Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
99Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
100100
101101The RBAC Groups API is available to Claude Enterprise organizations only.
102102
from line 148
148148curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
149149 -H 'Content-Type: application/json' \
150150 -H 'anthropic-version: 2023-06-01' \
151 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
151 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
152152 -d '{
153153 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
154154 }'
from line 170
170170
171171**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
172172
173Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
173Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
174174
175175The RBAC Groups API is available to Claude Enterprise organizations only.
176176
from line 208
208208curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
209209 -X DELETE \
210210 -H 'anthropic-version: 2023-06-01' \
211 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
211 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
212212```
213213
214214#### Response (200)
api/admin/rbac_roles Changed · +3 / -3 lines
from line 68
6868```bash
6969curl https://api.anthropic.com/v1/organizations/rbac_roles \
7070 -H 'anthropic-version: 2023-06-01' \
71 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
71 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
7272```
7373
7474#### Response (200)
from line 140
140140```bash
141141curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \
142142 -H 'anthropic-version: 2023-06-01' \
143 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
143 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
144144```
145145
146146#### Response (200)
from line 346
346346```bash
347347curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
348348 -H 'anthropic-version: 2023-06-01' \
349 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
349 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
350350```
351351
352352##### Response (200)
api/admin/service_accounts Changed · +37 / -24 lines
from line 4
44
55**POST** `/v1/organizations/service_accounts`
66
7**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).
8
79Create a service account.
810
911A service account is a named workload identity that federation rules
1012target. `organization_role` is `developer` (default) or `admin`; a rule
1113may only be created or retargeted to grant `org:admin` scope when the
12target's `organization_role` is `admin`. Requires an OAuth bearer (user
13or WIF-minted service account token) or a Console session; Admin API
14keys are not accepted. Creating an `admin`-role service account requires
15an interactive credential (a user OAuth token or a Console session) — a
16workload may only create `developer`-role service accounts.
14target's `organization_role` is `admin`. Creating an `admin`-role service
15account requires an interactive credential (a user OAuth token or a
16Console session) — a workload may only create `developer`-role service
17accounts.
1718
1819### Headers
1920
from line 115
114115curl https://api.anthropic.com/v1/organizations/service_accounts \
115116 -H 'Content-Type: application/json' \
116117 -H 'anthropic-version: 2023-06-01' \
117 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
118 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
118119 -d '{
119120 "name": "ci-deploy-bot"
120121 }'
from line 143
142143
143144**GET** `/v1/organizations/service_accounts/{service_account_id}`
144145
146**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).
147
145148Retrieve a service account by its ID (`svac_...`).
146149
147150### Path parameters
from line 229
226229```bash
227230curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
228231 -H 'anthropic-version: 2023-06-01' \
229 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
232 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
230233```
231234
232235#### Response (200)
from line 254
251254
252255**GET** `/v1/organizations/service_accounts`
253256
257**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).
258
254259List service accounts in the caller's organization.
255260
256261Results are ordered by creation time, newest first. Use `limit` and the
from line 355
350355```bash
351356curl https://api.anthropic.com/v1/organizations/service_accounts \
352357 -H 'anthropic-version: 2023-06-01' \
353 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
358 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
354359```
355360
356361#### Response (200)
from line 385
380385
381386**POST** `/v1/organizations/service_accounts/{service_account_id}`
382387
388**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).
389
383390Update a service account.
384391
385392Only `description` and `organization_role` are mutable; `name` cannot be
386393changed. Archived service accounts cannot be updated; this returns 400.
387394Setting `organization_role` to `admin` (even when unchanged) requires an
388interactive credential (a user OAuth token or a Console session). Admin
389API keys are not accepted.
395interactive credential (a user OAuth token or a Console session).
390396
391397### Path parameters
392398
from line 493
487493curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
488494 -H 'Content-Type: application/json' \
489495 -H 'anthropic-version: 2023-06-01' \
490 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
496 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
491497 -d '{}'
492498```
493499
from line 519
513519
514520**POST** `/v1/organizations/service_accounts/{service_account_id}/archive`
515521
522**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).
523
516524Archive a service account.
517525
518526Idempotent; re-archiving returns the service account with its original
from line 528
520528rule still targets this service account, same as issuer archival; archive
521529those rules first or change their target to another service account.
522530
523Requires an OAuth bearer or Console session; Admin API keys are not
524accepted.
525
526531### Path parameters
527532
528533- `service_account_id: string`
from line 611
606611curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \
607612 -X POST \
608613 -H 'anthropic-version: 2023-06-01' \
609 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
614 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
610615```
611616
612617#### Response (200)
from line 703
698703
699704**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
700705
706**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).
707
701708Add a service account to a workspace with the given `workspace_role`.
702709
703710Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from line 712
705712service account is already an explicit member of the workspace, its
706713`workspace_role` is replaced with the value supplied here. Archived
707714workspaces return 400. Archived service accounts cannot be added and are
708rejected. Requires an OAuth bearer or Console session; Admin API keys
709are not accepted.
715rejected.
710716
711717#### Path parameters
712718
from line 788
782788curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
783789 -H 'Content-Type: application/json' \
784790 -H 'anthropic-version: 2023-06-01' \
785 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
791 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
786792 -d '{
787793 "workspace_id": "workspace_id",
788794 "workspace_role": "workspace_admin"
from line 812
806812
807813**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
808814
815**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).
816
809817List the workspaces a service account is a member of.
810818
811819Each entry includes the service account's `workspace_role` in that
from line 823
815823the first page; with `limit=1` the first page may return up to 2 entries
816824(the implicit entry plus one explicit membership) so a pagination cursor
817825can be derived. Memberships are returned only while
818the service account is active; an archived service account returns an
819empty list.
826the service account is active. Without a `page` cursor, an archived
827service account returns an empty list. A `page` cursor that does not
828match an active membership returns a 400 invalid-request error. A cursor
829stops matching when the membership is removed, the workspace is deleted,
830or the service account is archived. Restart pagination from the first
831page to recover.
820832
821833#### Path parameters
822834
from line 903
891903```bash
892904curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
893905 -H 'anthropic-version: 2023-06-01' \
894 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
906 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
895907```
896908
897909##### Response (200)
from line 928
916928
917929**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
918930
931**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).
932
919933Remove a service account from a workspace.
920934
921935Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
from line 938
924938implicit default-workspace membership returns 200 but is a no-op and the
925939membership persists; deleting an explicit default-workspace row reverts
926940to the implicit `workspace_user` membership. Archived workspaces return
927400. Requires an OAuth bearer or Console session; Admin API keys are not
928accepted.
941400.
929942
930943#### Path parameters
931944
from line 978
965978curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
966979 -X DELETE \
967980 -H 'anthropic-version: 2023-06-01' \
968 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
981 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
969982```
970983
971984##### Response (200)
api/admin/service_accounts/archive Changed · +3 / -4 lines
from line 2
22
33**POST** `/v1/organizations/service_accounts/{service_account_id}/archive`
44
5**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).
6
57Archive a service account.
68
79Idempotent; re-archiving returns the service account with its original
from line 11
911rule still targets this service account, same as issuer archival; archive
1012those rules first or change their target to another service account.
1113
12Requires an OAuth bearer or Console session; Admin API keys are not
13accepted.
14
1514## Path parameters
1615
1716- `service_account_id: string`
from line 94
9594curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \
9695 -X POST \
9796 -H 'anthropic-version: 2023-06-01' \
98 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
97 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
9998```
10099
101100### Response (200)
api/admin/service_accounts/create Changed · +7 / -6 lines
from line 2
22
33**POST** `/v1/organizations/service_accounts`
44
5**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).
6
57Create a service account.
68
79A service account is a named workload identity that federation rules
810target. `organization_role` is `developer` (default) or `admin`; a rule
911may only be created or retargeted to grant `org:admin` scope when the
10target's `organization_role` is `admin`. Requires an OAuth bearer (user
11or WIF-minted service account token) or a Console session; Admin API
12keys are not accepted. Creating an `admin`-role service account requires
13an interactive credential (a user OAuth token or a Console session) — a
14workload may only create `developer`-role service accounts.
12target's `organization_role` is `admin`. Creating an `admin`-role service
13account requires an interactive credential (a user OAuth token or a
14Console session) — a workload may only create `developer`-role service
15accounts.
1516
1617## Headers
1718
from line 113
112113curl https://api.anthropic.com/v1/organizations/service_accounts \
113114 -H 'Content-Type: application/json' \
114115 -H 'anthropic-version: 2023-06-01' \
115 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
116 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
116117 -d '{
117118 "name": "ci-deploy-bot"
118119 }'
api/admin/service_accounts/update Changed · +4 / -3 lines
from line 2
22
33**POST** `/v1/organizations/service_accounts/{service_account_id}`
44
5**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).
6
57Update a service account.
68
79Only `description` and `organization_role` are mutable; `name` cannot be
810changed. Archived service accounts cannot be updated; this returns 400.
911Setting `organization_role` to `admin` (even when unchanged) requires an
10interactive credential (a user OAuth token or a Console session). Admin
11API keys are not accepted.
12interactive credential (a user OAuth token or a Console session).
1213
1314## Path parameters
1415
from line 110
109110curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
110111 -H 'Content-Type: application/json' \
111112 -H 'anthropic-version: 2023-06-01' \
112 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
113 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
113114 -d '{}'
114115```
115116
api/admin/service_accounts/workspaces Changed · +17 / -9 lines
from line 4
44
55**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
66
7**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).
8
79Add a service account to a workspace with the given `workspace_role`.
810
911Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from line 13
1113service account is already an explicit member of the workspace, its
1214`workspace_role` is replaced with the value supplied here. Archived
1315workspaces return 400. Archived service accounts cannot be added and are
14rejected. Requires an OAuth bearer or Console session; Admin API keys
15are not accepted.
16rejected.
1617
1718### Path parameters
1819
from line 89
8889curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
8990 -H 'Content-Type: application/json' \
9091 -H 'anthropic-version: 2023-06-01' \
91 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
92 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
9293 -d '{
9394 "workspace_id": "workspace_id",
9495 "workspace_role": "workspace_admin"
from line 113
112113
113114**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
114115
116**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).
117
115118List the workspaces a service account is a member of.
116119
117120Each entry includes the service account's `workspace_role` in that
from line 124
121124the first page; with `limit=1` the first page may return up to 2 entries
122125(the implicit entry plus one explicit membership) so a pagination cursor
123126can be derived. Memberships are returned only while
124the service account is active; an archived service account returns an
125empty list.
127the service account is active. Without a `page` cursor, an archived
128service account returns an empty list. A `page` cursor that does not
129match an active membership returns a 400 invalid-request error. A cursor
130stops matching when the membership is removed, the workspace is deleted,
131or the service account is archived. Restart pagination from the first
132page to recover.
126133
127134### Path parameters
128135
from line 204
197204```bash
198205curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
199206 -H 'anthropic-version: 2023-06-01' \
200 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
207 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
201208```
202209
203210#### Response (200)
from line 229
222229
223230**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
224231
232**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).
233
225234Remove a service account from a workspace.
226235
227236Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
from line 239
230239implicit default-workspace membership returns 200 but is a no-op and the
231240membership persists; deleting an explicit default-workspace row reverts
232241to the implicit `workspace_user` membership. Archived workspaces return
233400. Requires an OAuth bearer or Console session; Admin API keys are not
234accepted.
242400.
235243
236244### Path parameters
237245
from line 279
271279curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
272280 -X DELETE \
273281 -H 'anthropic-version: 2023-06-01' \
274 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
282 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
275283```
276284
277285#### Response (200)
api/admin/service_accounts/workspaces/create Changed · +4 / -3 lines
from line 2
22
33**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
44
5**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).
6
57Add a service account to a workspace with the given `workspace_role`.
68
79Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from line 11
911service account is already an explicit member of the workspace, its
1012`workspace_role` is replaced with the value supplied here. Archived
1113workspaces return 400. Archived service accounts cannot be added and are
12rejected. Requires an OAuth bearer or Console session; Admin API keys
13are not accepted.
14rejected.
1415
1516## Path parameters
1617
from line 87
8687curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
8788 -H 'Content-Type: application/json' \
8889 -H 'anthropic-version: 2023-06-01' \
89 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
90 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
9091 -d '{
9192 "workspace_id": "workspace_id",
9293 "workspace_role": "workspace_admin"
api/admin/service_accounts/workspaces/delete Changed · +4 / -3 lines
from line 2
22
33**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
44
5**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).
6
57Remove a service account from a workspace.
68
79Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
from line 12
1012implicit default-workspace membership returns 200 but is a no-op and the
1113membership persists; deleting an explicit default-workspace row reverts
1214to the implicit `workspace_user` membership. Archived workspaces return
13400. Requires an OAuth bearer or Console session; Admin API keys are not
14accepted.
15400.
1516
1617## Path parameters
1718
from line 52
5152curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
5253 -X DELETE \
5354 -H 'anthropic-version: 2023-06-01' \
54 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
55 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
5556```
5657
5758### Response (200)
api/admin/service_accounts/workspaces/list Changed · +9 / -3 lines
from line 2
22
33**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
44
5**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).
6
57List the workspaces a service account is a member of.
68
79Each entry includes the service account's `workspace_role` in that
from line 13
1113the first page; with `limit=1` the first page may return up to 2 entries
1214(the implicit entry plus one explicit membership) so a pagination cursor
1315can be derived. Memberships are returned only while
14the service account is active; an archived service account returns an
15empty list.
16the service account is active. Without a `page` cursor, an archived
17service account returns an empty list. A `page` cursor that does not
18match an active membership returns a 400 invalid-request error. A cursor
19stops matching when the membership is removed, the workspace is deleted,
20or the service account is archived. Restart pagination from the first
21page to recover.
1622
1723## Path parameters
1824
from line 93
8793```bash
8894curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
8995 -H 'anthropic-version: 2023-06-01' \
90 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
96 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
9197```
9298
9399### Response (200)
api/admin/spend_limits Changed · +8 / -8 lines
from line 138
138138curl https://api.anthropic.com/v1/organizations/spend_limits \
139139 -H 'Content-Type: application/json' \
140140 -H 'anthropic-version: 2023-06-01' \
141 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
141 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
142142 -d '{
143143 "amount": "50000",
144144 "scope": {
from line 278
278278```bash
279279curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
280280 -H 'anthropic-version: 2023-06-01' \
281 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
281 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
282282```
283283
284284#### Response (200)
from line 329
329329curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
330330 -X DELETE \
331331 -H 'anthropic-version: 2023-06-01' \
332 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
332 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
333333```
334334
335335#### Response (200)
from line 508
508508```bash
509509curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
510510 -H 'anthropic-version: 2023-06-01' \
511 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
511 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
512512```
513513
514514#### Response (200)
from line 1043
10431043```bash
10441044curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \
10451045 -H 'anthropic-version: 2023-06-01' \
1046 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1046 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
10471047```
10481048
10491049##### Response (200)
from line 1350
13501350```bash
13511351curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
13521352 -H 'anthropic-version: 2023-06-01' \
1353 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1353 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
13541354```
13551355
13561356##### Response (200)
from line 1761
17611761curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
17621762 -H 'Content-Type: application/json' \
17631763 -H 'anthropic-version: 2023-06-01' \
1764 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
1764 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
17651765 -d '{
17661766 "amount": "50000",
17671767 "period": "monthly"
from line 2085
20852085curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
20862086 -H 'Content-Type: application/json' \
20872087 -H 'anthropic-version: 2023-06-01' \
2088 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
2088 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
20892089 -d '{}'
20902090```
20912091
api/admin/spend_limits/increase_requests Changed · +4 / -4 lines
from line 270
270270```bash
271271curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \
272272 -H 'anthropic-version: 2023-06-01' \
273 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
273 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
274274```
275275
276276#### Response (200)
from line 577
577577```bash
578578curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
579579 -H 'anthropic-version: 2023-06-01' \
580 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
580 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
581581```
582582
583583#### Response (200)
from line 988
988988curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
989989 -H 'Content-Type: application/json' \
990990 -H 'anthropic-version: 2023-06-01' \
991 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
991 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
992992 -d '{
993993 "amount": "50000",
994994 "period": "monthly"
from line 1312
13121312curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
13131313 -H 'Content-Type: application/json' \
13141314 -H 'anthropic-version: 2023-06-01' \
1315 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
1315 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
13161316 -d '{}'
13171317```
13181318
api/admin/users Changed · +4 / -4 lines
from line 69
6969```bash
7070curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
7171 -H 'anthropic-version: 2023-06-01' \
72 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
72 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
7373```
7474
7575#### Response (200)
from line 190
190190```bash
191191curl https://api.anthropic.com/v1/organizations/users \
192192 -H 'anthropic-version: 2023-06-01' \
193 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
193 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
194194```
195195
196196#### Response (200)
from line 301
301301curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
302302 -H 'Content-Type: application/json' \
303303 -H 'anthropic-version: 2023-06-01' \
304 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
304 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
305305 -d '{
306306 "role": "user"
307307 }'
from line 352
352352curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
353353 -X DELETE \
354354 -H 'anthropic-version: 2023-06-01' \
355 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
355 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
356356```
357357
358358#### Response (200)
api/admin/workspaces Changed · +147 / -61 lines
from line 50
5050
5151 Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
5252
53- `display_color: optional string or null`
54
55 Hex color code representing the Workspace in the Anthropic Console.
56
57 maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
58
5359- `external_key_id: optional string or null`
5460
5561 ID of the customer-managed encryption key (CMEK) configuration to use for this
5662 Workspace. Setting this field requires CMEK to be enabled for your
5763 organization. When set, data stored for this Workspace is encrypted with the
58 referenced key. Create key configurations with the External Keys API. This
59 field is write-once: once a key is attached to a Workspace it cannot be
60 detached or replaced. To rotate key material, rotate the underlying key on
61 your cloud KMS; the `external_key_id` stays the same.
64 referenced key. Create key configurations with the External Keys API. On
65 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
66 single-Region key in the same AWS account and Region as the Workspace. On that
67 platform the key is validated against this Workspace when it is attached, so a
68 key-policy problem is reported as an error on this request. This field is write-once:
69 once a key is attached to a Workspace it cannot be detached or replaced. To
70 rotate key material, rotate the underlying key on your cloud KMS; the
71 `external_key_id` stays the same.
6272
6373- `tags: optional map[string] or null`
6474
from line 94
8494 customer-managed encryption key (CMEK) on AWS, reference this value in your
8595 KMS key-policy condition so the key is scoped to this compartment. On GCP and
8696 Azure, Anthropic enforces the compartment binding automatically; you do not
87 need to reference this value in your key configuration. See the CMEK integration guide for the
88 required key configuration, including the value used during key validation.
97 need to reference this value in your key configuration. See the CMEK
98 integration guide for the required key configuration; unless your organization
99 is on Claude Platform on AWS, it includes a separate value used during key
100 validation. On Claude Platform on AWS there is no separate validation value:
101 the key is validated against this Workspace's own value when it is attached, so
102 if your key policy uses the compartment condition, add this value to it before
103 attaching the key.
89104
90105 - `created_at: string`
91106
from line 137
122137 ID of the customer-managed encryption key (CMEK) configuration to use for this
123138 Workspace. Setting this field requires CMEK to be enabled for your
124139 organization. When set, data stored for this Workspace is encrypted with the
125 referenced key. Create key configurations with the External Keys API. This
126 field is write-once: once a key is attached to a Workspace it cannot be
127 detached or replaced. To rotate key material, rotate the underlying key on
128 your cloud KMS; the `external_key_id` stays the same.
140 referenced key. Create key configurations with the External Keys API. On
141 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
142 single-Region key in the same AWS account and Region as the Workspace. On that
143 platform the key is validated against this Workspace when it is attached, so a
144 key-policy problem is reported as an error on this request. This field is write-once:
145 once a key is attached to a Workspace it cannot be detached or replaced. To
146 rotate key material, rotate the underlying key on your cloud KMS; the
147 `external_key_id` stays the same.
129148
130149 - `name: string`
131150
from line 168
149168curl https://api.anthropic.com/v1/organizations/workspaces \
150169 -H 'Content-Type: application/json' \
151170 -H 'anthropic-version: 2023-06-01' \
152 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
171 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
153172 -d '{
154173 "name": "x",
174 "display_color": "#6C5BB9",
155175 "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
156176 "tags": {
157177 "env": "prod",
from line 236
216236 customer-managed encryption key (CMEK) on AWS, reference this value in your
217237 KMS key-policy condition so the key is scoped to this compartment. On GCP and
218238 Azure, Anthropic enforces the compartment binding automatically; you do not
219 need to reference this value in your key configuration. See the CMEK integration guide for the
220 required key configuration, including the value used during key validation.
239 need to reference this value in your key configuration. See the CMEK
240 integration guide for the required key configuration; unless your organization
241 is on Claude Platform on AWS, it includes a separate value used during key
242 validation. On Claude Platform on AWS there is no separate validation value:
243 the key is validated against this Workspace's own value when it is attached, so
244 if your key policy uses the compartment condition, add this value to it before
245 attaching the key.
221246
222247 - `created_at: string`
223248
from line 279
254279 ID of the customer-managed encryption key (CMEK) configuration to use for this
255280 Workspace. Setting this field requires CMEK to be enabled for your
256281 organization. When set, data stored for this Workspace is encrypted with the
257 referenced key. Create key configurations with the External Keys API. This
258 field is write-once: once a key is attached to a Workspace it cannot be
259 detached or replaced. To rotate key material, rotate the underlying key on
260 your cloud KMS; the `external_key_id` stays the same.
282 referenced key. Create key configurations with the External Keys API. On
283 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
284 single-Region key in the same AWS account and Region as the Workspace. On that
285 platform the key is validated against this Workspace when it is attached, so a
286 key-policy problem is reported as an error on this request. This field is write-once:
287 once a key is attached to a Workspace it cannot be detached or replaced. To
288 rotate key material, rotate the underlying key on your cloud KMS; the
289 `external_key_id` stays the same.
261290
262291 - `name: string`
263292
from line 309
280309```bash
281310curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
282311 -H 'anthropic-version: 2023-06-01' \
283 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
312 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
284313```
285314
286315#### Response (200)
from line 386
357386 customer-managed encryption key (CMEK) on AWS, reference this value in your
358387 KMS key-policy condition so the key is scoped to this compartment. On GCP and
359388 Azure, Anthropic enforces the compartment binding automatically; you do not
360 need to reference this value in your key configuration. See the CMEK integration guide for the
361 required key configuration, including the value used during key validation.
389 need to reference this value in your key configuration. See the CMEK
390 integration guide for the required key configuration; unless your organization
391 is on Claude Platform on AWS, it includes a separate value used during key
392 validation. On Claude Platform on AWS there is no separate validation value:
393 the key is validated against this Workspace's own value when it is attached, so
394 if your key policy uses the compartment condition, add this value to it before
395 attaching the key.
362396
363397 - `created_at: string`
364398
from line 429
395429 ID of the customer-managed encryption key (CMEK) configuration to use for this
396430 Workspace. Setting this field requires CMEK to be enabled for your
397431 organization. When set, data stored for this Workspace is encrypted with the
398 referenced key. Create key configurations with the External Keys API. This
399 field is write-once: once a key is attached to a Workspace it cannot be
400 detached or replaced. To rotate key material, rotate the underlying key on
401 your cloud KMS; the `external_key_id` stays the same.
432 referenced key. Create key configurations with the External Keys API. On
433 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
434 single-Region key in the same AWS account and Region as the Workspace. On that
435 platform the key is validated against this Workspace when it is attached, so a
436 key-policy problem is reported as an error on this request. This field is write-once:
437 once a key is attached to a Workspace it cannot be detached or replaced. To
438 rotate key material, rotate the underlying key on your cloud KMS; the
439 `external_key_id` stays the same.
402440
403441 - `name: string`
404442
from line 471
433471```bash
434472curl https://api.anthropic.com/v1/organizations/workspaces \
435473 -H 'anthropic-version: 2023-06-01' \
436 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
474 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
437475```
438476
439477#### Response (200)
from line 541
503541
504542 - `"us"`
505543
544- `display_color: optional string`
545
546 Hex color code representing the Workspace in the Anthropic Console.
547
548 maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
549
506550- `external_key_id: optional string`
507551
508552 ID of the customer-managed encryption key (CMEK) configuration to use for this
509553 Workspace. Setting this field requires CMEK to be enabled for your
510554 organization. When set, data stored for this Workspace is encrypted with the
511 referenced key. Create key configurations with the External Keys API. This
512 field is write-once: once a key is attached to a Workspace it cannot be
513 detached or replaced. To rotate key material, rotate the underlying key on
514 your cloud KMS; the `external_key_id` stays the same.
555 referenced key. Create key configurations with the External Keys API. On
556 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
557 single-Region key in the same AWS account and Region as the Workspace. On that
558 platform the key is validated against this Workspace when it is attached, so a
559 key-policy problem is reported as an error on this request. This field is write-once:
560 once a key is attached to a Workspace it cannot be detached or replaced. To
561 rotate key material, rotate the underlying key on your cloud KMS; the
562 `external_key_id` stays the same.
515563
516564- `name: optional string`
517565
from line 591
543591 customer-managed encryption key (CMEK) on AWS, reference this value in your
544592 KMS key-policy condition so the key is scoped to this compartment. On GCP and
545593 Azure, Anthropic enforces the compartment binding automatically; you do not
546 need to reference this value in your key configuration. See the CMEK integration guide for the
547 required key configuration, including the value used during key validation.
594 need to reference this value in your key configuration. See the CMEK
595 integration guide for the required key configuration; unless your organization
596 is on Claude Platform on AWS, it includes a separate value used during key
597 validation. On Claude Platform on AWS there is no separate validation value:
598 the key is validated against this Workspace's own value when it is attached, so
599 if your key policy uses the compartment condition, add this value to it before
600 attaching the key.
548601
549602 - `created_at: string`
550603
from line 634
581634 ID of the customer-managed encryption key (CMEK) configuration to use for this
582635 Workspace. Setting this field requires CMEK to be enabled for your
583636 organization. When set, data stored for this Workspace is encrypted with the
584 referenced key. Create key configurations with the External Keys API. This
585 field is write-once: once a key is attached to a Workspace it cannot be
586 detached or replaced. To rotate key material, rotate the underlying key on
587 your cloud KMS; the `external_key_id` stays the same.
637 referenced key. Create key configurations with the External Keys API. On
638 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
639 single-Region key in the same AWS account and Region as the Workspace. On that
640 platform the key is validated against this Workspace when it is attached, so a
641 key-policy problem is reported as an error on this request. This field is write-once:
642 once a key is attached to a Workspace it cannot be detached or replaced. To
643 rotate key material, rotate the underlying key on your cloud KMS; the
644 `external_key_id` stays the same.
588645
589646 - `name: string`
590647
from line 665
608665curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
609666 -H 'Content-Type: application/json' \
610667 -H 'anthropic-version: 2023-06-01' \
611 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
668 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
612669 -d '{
670 "display_color": "#6C5BB9",
613671 "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
614672 "tags": {
615673 "env": "prod",
from line 730
672730 customer-managed encryption key (CMEK) on AWS, reference this value in your
673731 KMS key-policy condition so the key is scoped to this compartment. On GCP and
674732 Azure, Anthropic enforces the compartment binding automatically; you do not
675 need to reference this value in your key configuration. See the CMEK integration guide for the
676 required key configuration, including the value used during key validation.
733 need to reference this value in your key configuration. See the CMEK
734 integration guide for the required key configuration; unless your organization
735 is on Claude Platform on AWS, it includes a separate value used during key
736 validation. On Claude Platform on AWS there is no separate validation value:
737 the key is validated against this Workspace's own value when it is attached, so
738 if your key policy uses the compartment condition, add this value to it before
739 attaching the key.
677740
678741 - `created_at: string`
679742
from line 773
710773 ID of the customer-managed encryption key (CMEK) configuration to use for this
711774 Workspace. Setting this field requires CMEK to be enabled for your
712775 organization. When set, data stored for this Workspace is encrypted with the
713 referenced key. Create key configurations with the External Keys API. This
714 field is write-once: once a key is attached to a Workspace it cannot be
715 detached or replaced. To rotate key material, rotate the underlying key on
716 your cloud KMS; the `external_key_id` stays the same.
776 referenced key. Create key configurations with the External Keys API. On
777 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
778 single-Region key in the same AWS account and Region as the Workspace. On that
779 platform the key is validated against this Workspace when it is attached, so a
780 key-policy problem is reported as an error on this request. This field is write-once:
781 once a key is attached to a Workspace it cannot be detached or replaced. To
782 rotate key material, rotate the underlying key on your cloud KMS; the
783 `external_key_id` stays the same.
717784
718785 - `name: string`
719786
from line 804
737804curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
738805 -X POST \
739806 -H 'anthropic-version: 2023-06-01' \
740 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
807 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
741808```
742809
743810#### Response (200)
from line 903
836903curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
837904 -H 'Content-Type: application/json' \
838905 -H 'anthropic-version: 2023-06-01' \
839 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
906 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
840907 -d '{
841908 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
842909 "workspace_role": "workspace_admin"
from line 976
909976```bash
910977curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
911978 -H 'anthropic-version: 2023-06-01' \
912 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
979 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
913980```
914981
915982##### Response (200)
from line 1071
10041071```bash
10051072curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
10061073 -H 'anthropic-version: 2023-06-01' \
1007 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1074 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
10081075```
10091076
10101077##### Response (200)
from line 1164
10971164curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
10981165 -H 'Content-Type: application/json' \
10991166 -H 'anthropic-version: 2023-06-01' \
1100 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
1167 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
11011168 -d '{
11021169 "workspace_role": "workspace_admin"
11031170 }'
from line 1221
11541221curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
11551222 -X DELETE \
11561223 -H 'anthropic-version: 2023-06-01' \
1157 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1224 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
11581225```
11591226
11601227##### Response (200)
from line 1246
11791246override. Groups without overrides inherit the organization limits and
11801247are not listed; use `GET /v1/organizations/rate_limits` to see those.
11811248
1249When `limit` is omitted, every matching entry is returned in a single
1250page; when `limit` truncates the result, follow `next_page` to fetch
1251the remaining entries.
1252
11821253#### Path parameters
11831254
11841255- `workspace_id: string`
from line 1274
12031274
12041275 - `"web_search"`
12051276
1277- `limit: optional number`
1278
1279 Maximum number of items to return per page. Ranges from `1` to `1000`.
1280
1281 When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
1282
1283 maximum: 1000, minimum: 1
1284
12061285- `page: optional string`
12071286
12081287 Opaque cursor from a previous response's `next_page`.
from line 1344
12651344
12661345- `next_page: string or null`
12671346
1268 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
1347 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
12691348
12701349#### Example
12711350
from line 1351
12721351```bash
12731352curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
12741353 -H 'anthropic-version: 2023-06-01' \
1275 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1354 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
12761355```
12771356
12781357##### Response (200)
from line 1386
13071386
13081387**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
13091388
1389**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).
1390
13101391Add a service account to a workspace with the given `workspace_role`.
13111392
13121393The role determines what the service account can do in the workspace and
from line 1397
13161397assigns a chosen role. If the service account is already an explicit
13171398member of the workspace, its `workspace_role` is replaced with the
13181399value supplied here. Archived workspaces return 400. Archived service
1319accounts cannot be added and are rejected. Requires an OAuth bearer or
1320Console session; Admin API keys are not accepted.
1400accounts cannot be added and are rejected.
13211401
13221402#### Path parameters
13231403
from line 1473
13931473curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
13941474 -H 'Content-Type: application/json' \
13951475 -H 'anthropic-version: 2023-06-01' \
1396 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
1476 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
13971477 -d '{
13981478 "service_account_id": "service_account_id",
13991479 "workspace_role": "workspace_admin"
from line 1497
14171497
14181498**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
14191499
1500**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).
1501
14201502Retrieve a service account's membership in a workspace.
14211503
14221504Returns the membership record, including the service account's
from line 1567
14851567```bash
14861568curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
14871569 -H 'anthropic-version: 2023-06-01' \
1488 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1570 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
14891571```
14901572
14911573##### Response (200)
from line 1587
15051587
15061588**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
15071589
1590**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).
1591
15081592List the service accounts that are members of a workspace.
15091593
15101594Each entry includes the service account's `workspace_role`. Use `limit`
from line 1671
15871671```bash
15881672curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
15891673 -H 'anthropic-version: 2023-06-01' \
1590 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1674 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
15911675```
15921676
15931677##### Response (200)
from line 1696
16121696
16131697**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
16141698
1699**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).
1700
16151701Change a service account's role in a workspace.
16161702
16171703The new `workspace_role` replaces the current one. Only explicit
from line 1705
16191705default-workspace membership, add the service account explicitly with
16201706`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces
16211707return 400. Archived service accounts cannot be updated and are
1622rejected. Requires an OAuth bearer or Console session; Admin API keys
1623are not accepted.
1708rejected.
16241709
16251710#### Path parameters
16261711
from line 1781
16961781curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
16971782 -H 'Content-Type: application/json' \
16981783 -H 'anthropic-version: 2023-06-01' \
1699 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
1784 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
17001785 -d '{
17011786 "workspace_role": "workspace_admin"
17021787 }'
from line 1804
17191804
17201805**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
17211806
1807**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).
1808
17221809Remove a service account from a workspace.
17231810
17241811Removal is idempotent (returns 200 even if the membership was already
from line 1812
17251812removed). A DELETE against the implicit default-workspace membership
17261813returns 200 but is a no-op and the membership persists; deleting an
17271814explicit default-workspace row reverts to the implicit `workspace_user`
1728membership. Archived workspaces return 400. Requires an OAuth bearer or
1729Console session; Admin API keys are not accepted.
1815membership. Archived workspaces return 400.
17301816
17311817#### Path parameters
17321818
from line 1852
17661852curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
17671853 -X DELETE \
17681854 -H 'anthropic-version: 2023-06-01' \
1769 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
1855 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
17701856```
17711857
17721858##### Response (200)
api/admin/workspaces/archive Changed · +16 / -7 lines
from line 28
2828 customer-managed encryption key (CMEK) on AWS, reference this value in your
2929 KMS key-policy condition so the key is scoped to this compartment. On GCP and
3030 Azure, Anthropic enforces the compartment binding automatically; you do not
31 need to reference this value in your key configuration. See the CMEK integration guide for the
32 required key configuration, including the value used during key validation.
31 need to reference this value in your key configuration. See the CMEK
32 integration guide for the required key configuration; unless your organization
33 is on Claude Platform on AWS, it includes a separate value used during key
34 validation. On Claude Platform on AWS there is no separate validation value:
35 the key is validated against this Workspace's own value when it is attached, so
36 if your key policy uses the compartment condition, add this value to it before
37 attaching the key.
3338
3439 - `created_at: string`
3540
from line 71
6671 ID of the customer-managed encryption key (CMEK) configuration to use for this
6772 Workspace. Setting this field requires CMEK to be enabled for your
6873 organization. When set, data stored for this Workspace is encrypted with the
69 referenced key. Create key configurations with the External Keys API. This
70 field is write-once: once a key is attached to a Workspace it cannot be
71 detached or replaced. To rotate key material, rotate the underlying key on
72 your cloud KMS; the `external_key_id` stays the same.
74 referenced key. Create key configurations with the External Keys API. On
75 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
76 single-Region key in the same AWS account and Region as the Workspace. On that
77 platform the key is validated against this Workspace when it is attached, so a
78 key-policy problem is reported as an error on this request. This field is write-once:
79 once a key is attached to a Workspace it cannot be detached or replaced. To
80 rotate key material, rotate the underlying key on your cloud KMS; the
81 `external_key_id` stays the same.
7382
7483 - `name: string`
7584
from line 102
93102curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
94103 -X POST \
95104 -H 'anthropic-version: 2023-06-01' \
96 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
105 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
97106```
98107
99108### Response (200)
api/admin/workspaces/create Changed · +31 / -11 lines
from line 48
4848
4949 Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
5050
51- `display_color: optional string or null`
52
53 Hex color code representing the Workspace in the Anthropic Console.
54
55 maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
56
5157- `external_key_id: optional string or null`
5258
5359 ID of the customer-managed encryption key (CMEK) configuration to use for this
5460 Workspace. Setting this field requires CMEK to be enabled for your
5561 organization. When set, data stored for this Workspace is encrypted with the
56 referenced key. Create key configurations with the External Keys API. This
57 field is write-once: once a key is attached to a Workspace it cannot be
58 detached or replaced. To rotate key material, rotate the underlying key on
59 your cloud KMS; the `external_key_id` stays the same.
62 referenced key. Create key configurations with the External Keys API. On
63 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
64 single-Region key in the same AWS account and Region as the Workspace. On that
65 platform the key is validated against this Workspace when it is attached, so a
66 key-policy problem is reported as an error on this request. This field is write-once:
67 once a key is attached to a Workspace it cannot be detached or replaced. To
68 rotate key material, rotate the underlying key on your cloud KMS; the
69 `external_key_id` stays the same.
6070
6171- `tags: optional map[string] or null`
6272
from line 92
8292 customer-managed encryption key (CMEK) on AWS, reference this value in your
8393 KMS key-policy condition so the key is scoped to this compartment. On GCP and
8494 Azure, Anthropic enforces the compartment binding automatically; you do not
85 need to reference this value in your key configuration. See the CMEK integration guide for the
86 required key configuration, including the value used during key validation.
95 need to reference this value in your key configuration. See the CMEK
96 integration guide for the required key configuration; unless your organization
97 is on Claude Platform on AWS, it includes a separate value used during key
98 validation. On Claude Platform on AWS there is no separate validation value:
99 the key is validated against this Workspace's own value when it is attached, so
100 if your key policy uses the compartment condition, add this value to it before
101 attaching the key.
87102
88103 - `created_at: string`
89104
from line 135
120135 ID of the customer-managed encryption key (CMEK) configuration to use for this
121136 Workspace. Setting this field requires CMEK to be enabled for your
122137 organization. When set, data stored for this Workspace is encrypted with the
123 referenced key. Create key configurations with the External Keys API. This
124 field is write-once: once a key is attached to a Workspace it cannot be
125 detached or replaced. To rotate key material, rotate the underlying key on
126 your cloud KMS; the `external_key_id` stays the same.
138 referenced key. Create key configurations with the External Keys API. On
139 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
140 single-Region key in the same AWS account and Region as the Workspace. On that
141 platform the key is validated against this Workspace when it is attached, so a
142 key-policy problem is reported as an error on this request. This field is write-once:
143 once a key is attached to a Workspace it cannot be detached or replaced. To
144 rotate key material, rotate the underlying key on your cloud KMS; the
145 `external_key_id` stays the same.
127146
128147 - `name: string`
129148
from line 166
147166curl https://api.anthropic.com/v1/organizations/workspaces \
148167 -H 'Content-Type: application/json' \
149168 -H 'anthropic-version: 2023-06-01' \
150 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
169 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
151170 -d '{
152171 "name": "x",
172 "display_color": "#6C5BB9",
153173 "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
154174 "tags": {
155175 "env": "prod",
api/admin/workspaces/list Changed · +16 / -7 lines
from line 48
4848 customer-managed encryption key (CMEK) on AWS, reference this value in your
4949 KMS key-policy condition so the key is scoped to this compartment. On GCP and
5050 Azure, Anthropic enforces the compartment binding automatically; you do not
51 need to reference this value in your key configuration. See the CMEK integration guide for the
52 required key configuration, including the value used during key validation.
51 need to reference this value in your key configuration. See the CMEK
52 integration guide for the required key configuration; unless your organization
53 is on Claude Platform on AWS, it includes a separate value used during key
54 validation. On Claude Platform on AWS there is no separate validation value:
55 the key is validated against this Workspace's own value when it is attached, so
56 if your key policy uses the compartment condition, add this value to it before
57 attaching the key.
5358
5459 - `created_at: string`
5560
from line 91
8691 ID of the customer-managed encryption key (CMEK) configuration to use for this
8792 Workspace. Setting this field requires CMEK to be enabled for your
8893 organization. When set, data stored for this Workspace is encrypted with the
89 referenced key. Create key configurations with the External Keys API. This
90 field is write-once: once a key is attached to a Workspace it cannot be
91 detached or replaced. To rotate key material, rotate the underlying key on
92 your cloud KMS; the `external_key_id` stays the same.
94 referenced key. Create key configurations with the External Keys API. On
95 Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a
96 single-Region key in the same AWS account and Region as the Workspace. On that
97 platform the key is validated against this Workspace when it is attached, so a
98 key-policy problem is reported as an error on this request. This field is write-once:
99 once a key is attached to a Workspace it cannot be detached or replaced. To
100 rotate key material, rotate the underlying key on your cloud KMS; the
101 `external_key_id` stays the same.
93102
94103 - `name: string`
95104
from line 133
124133```bash
125134curl https://api.anthropic.com/v1/organizations/workspaces \
126135 -H 'anthropic-version: 2023-06-01' \
127 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
136 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
128137```
129138
130139### Response (200)
api/admin/workspaces/members Changed · +5 / -5 lines
from line 70
7070curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
7171 -H 'Content-Type: application/json' \
7272 -H 'anthropic-version: 2023-06-01' \
73 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
73 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
7474 -d '{
7575 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
7676 "workspace_role": "workspace_admin"
from line 143
143143```bash
144144curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
145145 -H 'anthropic-version: 2023-06-01' \
146 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
146 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
147147```
148148
149149#### Response (200)
from line 238
238238```bash
239239curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
240240 -H 'anthropic-version: 2023-06-01' \
241 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
241 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
242242```
243243
244244#### Response (200)
from line 331
331331curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
332332 -H 'Content-Type: application/json' \
333333 -H 'anthropic-version: 2023-06-01' \
334 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
334 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
335335 -d '{
336336 "workspace_role": "workspace_admin"
337337 }'
from line 388
388388curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
389389 -X DELETE \
390390 -H 'anthropic-version: 2023-06-01' \
391 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
391 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
392392```
393393
394394#### Response (200)
api/admin/workspaces/rate_limits Changed · +63 / -59 lines
from line 10
1010override. Groups without overrides inherit the organization limits and
1111are not listed; use `GET /v1/organizations/rate_limits` to see those.
1212
13When `limit` is omitted, every matching entry is returned in a single
14page; when `limit` truncates the result, follow `next_page` to fetch
15the remaining entries.
16
1317### Path parameters
1418
1519- `workspace_id: string`
from line 38
3438
3539 - `"web_search"`
3640
41- `limit: optional number`
42
43 Maximum number of items to return per page. Ranges from `1` to `1000`.
44
45 When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
46
47 maximum: 1000, minimum: 1
48
3749- `page: optional string`
3850
3951 Opaque cursor from a previous response's `next_page`.
from line 108
96108
97109- `next_page: string or null`
98110
99 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
111 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
100112
101113### Example
102114
from line 115
103115```bash
104116curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
105117 -H 'anthropic-version: 2023-06-01' \
106 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
118 -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
107119```
108120
109121#### Response (200)
from line 150
138150
139151- `RateLimitListResponse object`
140152
141 - `data: array of object`
153 - `group_type: "batch" or "files" or "model_group" or 3 more`
142154
143 Rate-limit entries for the workspace, one per group that has at least one override.
155 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`.
144156
145 - `group_type: "batch" or "files" or "model_group" or 3 more`
157 - `"batch"`
146158
147 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`.
159 - `"files"`
148160
149 - `"batch"`
161 - `"model_group"`
150162
151 - `"files"`
163 - `"skills"`
152164
153 - `"model_group"`
165 - `"token_count"`
154166
155 - `"skills"`
167 - `"web_search"`
156168
157 - `"token_count"`
169 - `limits: array of object`
158170
159 - `"web_search"`
171 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
160172
161 - `limits: array of object`
173 - `org_limit: number or null`
162174
163 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
175 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
164176
165 - `org_limit: number or null`
177 - `type: string`
166178
167 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
179 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
168180
169 - `type: string`
181 - `value: number`
170182
171 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
183 The workspace-level override value for this limiter type.
172184
173 - `value: number`
185 - `models: array of string or null`
174186
175 The workspace-level override value for this limiter type.
187 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
176188
177 - `models: array of string or null`
189 - `rate_limit_id: string`
178190
179 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
191 The `id` of the RateLimit group this override applies to.
180192
181 - `rate_limit_id: string`
193 - `type: "workspace_rate_limit"`
182194
183 The `id` of the RateLimit group this override applies to.
195 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
184196
185 - `type: "workspace_rate_limit"`
197 default: workspace_rate_limit
186198
187 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
199 - `workspace_id: string`
188200
189 default: workspace_rate_limit
190
191 - `workspace_id: string`
192
193 ID of the Workspace this override applies to.
194
195 - `next_page: string or null`
196
197 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
201 ID of the Workspace this override applies to.
198202