One read of Claude Developer Platformapi-20260825T033708Z
377 pages moved out of 612 read.
Pages moved
377
significant first
Pages read
612
in this capture
Captured
03:37 UTC
Corpus hash
7d98cae5bb87
corpus-hash
What this read moved
76-100 of 377, page 4 of 16This capture is too large to show at once. Changes 76-100 of 377 are below, significant first; the rest are on the following screens.
api/admin/rbac_groups/members/create Changed · +13 / -16 lines
# Add RBAC Group Member ## Path parameters ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Add RBAC Group Member ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Add RBAC Group Member
3url: https://platform.claude.com/docs/en/api/admin/rbac_groups/members/create
4---
1# Add RBAC Group Member
52
6## Add RBAC Group Member
3**POST** `/v1/organizations/rbac_groups/{group_id}/members`
74
8**post** `/v1/organizations/rbac_groups/{group_id}/members`
9
105Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
116
127The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `group_id: string`
1712
1813 ID of the RBAC Group.
1914
20### Header Parameters
15## Headers
2116
2217- `"anthropic-beta": optional array of string`
2318
from line 20
2520
2621 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2722
28### Body Parameters
23## Body parameters
2924
3025- `user_id: string`
3126
3227 ID of the User.
3328
34### Returns
29## Returns
3530
36- `RbacGroupMember object { created_at, email, group_id, 2 more }`
31- `RbacGroupMember object`
3732
3833 - `created_at: string`
3934
4035 RFC 3339 timestamp of when the User was added to the RBAC Group.
4136
37 format: date-time
38
4239 - `email: string`
4340
4441 Email of the User.
from line 50
5350
5451 For RBAC Group Members, this is always `"rbac_group_member"`.
5552
56 - `"rbac_group_member"`
53 default: rbac_group_member
5754
5855 - `user_id: string`
5956
6057 ID of the User.
6158
62### Example
59## Example
6360
64```http
61```bash
6562curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
6663 -H 'Content-Type: application/json' \
6764 -H 'anthropic-version: 2023-06-01' \
from line 68
7168 }'
7269```
7370
74#### Response
71### Response (200)
7572
7673```json
7774{
api/admin/rbac_groups/members/delete Changed · +10 / -15 lines
# Remove RBAC Group Member ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Remove RBAC Group Member ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Remove RBAC Group Member
3url: https://platform.claude.com/docs/en/api/admin/rbac_groups/members/delete
4---
1# Remove RBAC Group Member
52
6## Remove RBAC Group Member
3**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
74
8**delete** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
9
105Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
116
127The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `group_id: string`
1712
from line 16
2116
2217 ID of the User.
2318
24### Header Parameters
19## Headers
2520
2621- `"anthropic-beta": optional array of string`
2722
from line 24
2924
3025 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3126
32### Returns
27## Returns
3328
34- `RbacGroupMemberDeleted object { group_id, type, user_id }`
29- `RbacGroupMemberDeleted object`
3530
3631 - `group_id: string`
3732
from line 36
4136
4237 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
4338
44 - `"rbac_group_member_deleted"`
39 default: rbac_group_member_deleted
4540
4641 - `user_id: string`
4742
4843 ID of the User.
4944
50### Example
45## Example
5146
52```http
47```bash
5348curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
5449 -X DELETE \
5550 -H 'anthropic-version: 2023-06-01' \
from line 51
5651 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
5752```
5853
59#### Response
54### Response (200)
6055
6156```json
6257{
api/admin/rbac_groups/members/list Changed · +14 / -15 lines
# List RBAC Group Members ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List RBAC Group Members ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: List RBAC Group Members
3url: https://platform.claude.com/docs/en/api/admin/rbac_groups/members/list
4---
1# List RBAC Group Members
52
6## List RBAC Group Members
3**GET** `/v1/organizations/rbac_groups/{group_id}/members`
74
8**get** `/v1/organizations/rbac_groups/{group_id}/members`
9
105List members of an RBAC Group.
116
127The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `group_id: string`
1712
1813 ID of the RBAC Group.
1914
20### Query Parameters
15## Query parameters
2116
2217- `limit: optional number`
2318
from line 20
2520
2621 Defaults to `20`. Ranges from `1` to `1000`.
2722
23 default: 20, maximum: 1000, minimum: 1
24
2825- `page: optional string`
2926
3027 Optionally set to the `next_page` token from the previous response.
3128
32### Header Parameters
29## Headers
3330
3431- `"anthropic-beta": optional array of string`
3532
from line 34
3734
3835 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3936
40### Returns
37## Returns
4138
4239- `data: array of RbacGroupMember`
4340
from line 42
4542
4643 RFC 3339 timestamp of when the User was added to the RBAC Group.
4744
45 format: date-time
46
4847 - `email: string`
4948
5049 Email of the User.
from line 58
5958
6059 For RBAC Group Members, this is always `"rbac_group_member"`.
6160
62 - `"rbac_group_member"`
61 default: rbac_group_member
6362
6463 - `user_id: string`
6564
from line 72
7372
7473 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
7574
76### Example
75## Example
7776
78```http
77```bash
7978curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
8079 -H 'anthropic-version: 2023-06-01' \
8180 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
8281```
8382
84#### Response
83### Response (200)
8584
8685```json
8786{
api/admin/rbac_groups/retrieve Changed · +14 / -15 lines
# Get RBAC Group ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get RBAC Group ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Get RBAC Group
3url: https://platform.claude.com/docs/en/api/admin/rbac_groups/retrieve
4---
1# Get RBAC Group
52
6## Get RBAC Group
3**GET** `/v1/organizations/rbac_groups/{group_id}`
74
8**get** `/v1/organizations/rbac_groups/{group_id}`
9
105Retrieve an RBAC Group by ID.
116
127The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `group_id: string`
1712
1813 ID of the RBAC Group.
1914
20### Header Parameters
15## Headers
2116
2217- `"anthropic-beta": optional array of string`
2318
from line 20
2520
2621 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2722
28### Returns
23## Returns
2924
30- `RbacGroup object { id, created_at, name, 4 more }`
25- `RbacGroup object`
3126
3227 - `id: string`
3328
from line 32
3732
3833 RFC 3339 timestamp of when the RBAC Group was created.
3934
35 format: date-time
36
4037 - `name: string`
4138
4239 Name of the RBAC Group. Not uniqueness-enforced.
from line 56
5956
6057 For RBAC Groups, this is always `"rbac_group"`.
6158
62 - `"rbac_group"`
59 default: rbac_group
6360
6461 - `updated_at: string`
6562
6663 RFC 3339 timestamp of when the RBAC Group was last updated.
6764
68### Example
65 format: date-time
6966
70```http
67## Example
68
69```bash
7170curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
7271 -H 'anthropic-version: 2023-06-01' \
7372 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
7473```
7574
76#### Response
75### Response (200)
7776
7877```json
7978{
api/admin/rbac_groups/update Changed · +17 / -16 lines
# Update RBAC Group ## Path parameters ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Update RBAC Group ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Update RBAC Group
3url: https://platform.claude.com/docs/en/api/admin/rbac_groups/update
4---
1# Update RBAC Group
52
6## Update RBAC Group
3**POST** `/v1/organizations/rbac_groups/{group_id}`
74
8**post** `/v1/organizations/rbac_groups/{group_id}`
9
105Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
116
127The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `group_id: string`
1712
1813 ID of the RBAC Group.
1914
20### Header Parameters
15## Headers
2116
2217- `"anthropic-beta": optional array of string`
2318
from line 20
2520
2621 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2722
28### Body Parameters
23## Body parameters
2924
3025- `name: optional string or null`
3126
3227 Name of the RBAC Group. Not uniqueness-enforced.
3328
34### Returns
29 maxLength: 255, minLength: 1
3530
36- `RbacGroup object { id, created_at, name, 4 more }`
31## Returns
3732
33- `RbacGroup object`
34
3835 - `id: string`
3936
4037 ID of the RBAC Group.
from line 40
4340
4441 RFC 3339 timestamp of when the RBAC Group was created.
4542
43 format: date-time
44
4645 - `name: string`
4746
4847 Name of the RBAC Group. Not uniqueness-enforced.
from line 64
6564
6665 For RBAC Groups, this is always `"rbac_group"`.
6766
68 - `"rbac_group"`
67 default: rbac_group
6968
7069 - `updated_at: string`
7170
7271 RFC 3339 timestamp of when the RBAC Group was last updated.
7372
74### Example
73 format: date-time
7574
76```http
75## Example
76
77```bash
7778curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
7879 -H 'Content-Type: application/json' \
7980 -H 'anthropic-version: 2023-06-01' \
from line 84
8384 }'
8485```
8586
86#### Response
87### Response (200)
8788
8889```json
8990{
api/admin/rbac_roles Changed · +61 / -165 lines
### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## RBAC Roles › Permissions ### List RBAC Role Permissions #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Permissions ## List RBAC Role Permissions ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### Rbac Role Permission
from line 1
1---
2title: RBAC Roles
3url: https://platform.claude.com/docs/en/api/admin/rbac_roles
4---
5
61# RBAC Roles
72
83## List RBAC Roles
94
10**get** `/v1/organizations/rbac_roles`
5**GET** `/v1/organizations/rbac_roles`
116
127List RBAC Roles in the organization.
138
149The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
1510
16### Query Parameters
11### Query parameters
1712
1813- `limit: optional number`
1914
from line 16
2116
2217 Defaults to `20`. Ranges from `1` to `1000`.
2318
19 default: 20, maximum: 1000, minimum: 1
20
2421- `page: optional string`
2522
2623 Optionally set to the `next_page` token from the previous response.
2724
28### Header Parameters
25### Headers
2926
3027- `"anthropic-beta": optional array of string`
3128
from line 42
4542
4643 RFC 3339 datetime string indicating when the RBAC Role was created.
4744
45 format: date-time
46
4847 - `name: string`
4948
5049 Name of the RBAC Role.
from line 54
5554
5655 For RBAC Roles, this is always `"rbac_role"`.
5756
58 - `"rbac_role"`
57 default: rbac_role
5958
6059 - `updated_at: string`
6160
6261 RFC 3339 datetime string indicating when the RBAC Role was last updated.
6362
63 format: date-time
64
6465- `has_more: boolean`
6566
6667 Indicates whether there are more results beyond this page.
from line 73
7273
7374### Example
7475
75```http
76```bash
7677curl https://api.anthropic.com/v1/organizations/rbac_roles \
7778 -H 'anthropic-version: 2023-06-01' \
7879 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
7980```
8081
81#### Response
82#### Response (200)
8283
8384```json
8485{
from line 99
9899
99100## Get RBAC Role
100101
101**get** `/v1/organizations/rbac_roles/{role_id}`
102**GET** `/v1/organizations/rbac_roles/{role_id}`
102103
103104Retrieve an RBAC Role by ID.
104105
105106The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
106107
107### Path Parameters
108### Path parameters
108109
109110- `role_id: string`
110111
111112 ID of the RBAC Role.
112113
113### Header Parameters
114### Headers
114115
115116- `"anthropic-beta": optional array of string`
116117
from line 121
120121
121122### Returns
122123
123- `RbacRole object { id, created_at, name, 2 more }`
124- `RbacRole object`
124125
125126 - `id: string`
126127
from line 131
130131
131132 RFC 3339 datetime string indicating when the RBAC Role was created.
132133
134 format: date-time
135
133136 - `name: string`
134137
135138 Name of the RBAC Role.
from line 143
140143
141144 For RBAC Roles, this is always `"rbac_role"`.
142145
143 - `"rbac_role"`
146 default: rbac_role
144147
145148 - `updated_at: string`
146149
147150 RFC 3339 datetime string indicating when the RBAC Role was last updated.
148151
152 format: date-time
153
149154### Example
150155
151```http
156```bash
152157curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \
153158 -H 'anthropic-version: 2023-06-01' \
154159 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
155160```
156161
157#### Response
162#### Response (200)
158163
159164```json
160165{
from line 171
166171}
167172```
168173
169## Domain Types
174## Domain types
170175
171176### Rbac Role
172177
173- `RbacRole object { id, created_at, name, 2 more }`
178- `RbacRole object`
174179
175180 - `id: string`
176181
from line 185
180185
181186 RFC 3339 datetime string indicating when the RBAC Role was created.
182187
188 format: date-time
189
183190 - `name: string`
184191
185192 Name of the RBAC Role.
from line 197
190197
191198 For RBAC Roles, this is always `"rbac_role"`.
192199
193 - `"rbac_role"`
200 default: rbac_role
194201
195202 - `updated_at: string`
196203
197204 RFC 3339 datetime string indicating when the RBAC Role was last updated.
198205
199# Permissions
206 format: date-time
200207
201## List RBAC Role Permissions
208## RBAC Roles › Permissions
202209
203**get** `/v1/organizations/rbac_roles/{role_id}/permissions`
210### List RBAC Role Permissions
204211
212**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`
213
205214List the permissions an RBAC Role grants.
206215
207216The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
208217
209### Path Parameters
218#### Path parameters
210219
211220- `role_id: string`
212221
213222 ID of the RBAC Role.
214223
215### Query Parameters
224#### Query parameters
216225
217226- `limit: optional number`
218227
from line 229
220229
221230 Defaults to `20`. Ranges from `1` to `1000`.
222231
232 default: 20, maximum: 1000, minimum: 1
233
223234- `page: optional string`
224235
225236 Optionally set to the `next_page` token from the previous response.
226237
227### Header Parameters
238#### Headers
228239
229240- `"anthropic-beta": optional array of string`
230241
from line 243
232243
233244 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
234245
235### Returns
246#### Returns
236247
237248- `data: array of RbacRolePermission`
238249
from line 266
255266 `all_connectors` grants carry a tool-access action, the scope action, or
256267 an authentication-method action (`interactive` or `managed`).
257268
258 - `resource: object { organization_id, type } or object { connector_id, tool_name, type } or object { connector_id, scope, type } or 2 more`
269 - `resource: object or object or object or 2 more`
259270
260271 What the permission applies to.
261272
from line 273
262273 A tagged union: `type` names the kind of resource and determines which
263274 identifier fields are present.
264275
265 - `Organization object { organization_id, type }`
276 - `Organization object`
266277
267278 - `organization_id: string`
268279
from line 283
272283
273284 Kind of resource the permission applies to.
274285
275 - `"organization"`
286 default: organization
276287
277 - `ConnectorTool object { connector_id, tool_name, type }`
288 - `ConnectorTool object`
278289
279290 - `connector_id: string`
280291
from line 304
293304
294305 Kind of resource the permission applies to.
295306
296 - `"connector_tool"`
307 default: connector_tool
297308
298 - `ConnectorScope object { connector_id, scope, type }`
309 - `ConnectorScope object`
299310
300311 - `connector_id: string`
301312
from line 326
315326
316327 Kind of resource the permission applies to.
317328
318 - `"connector_scope"`
329 default: connector_scope
319330
320 - `Connector object { connector_id, type }`
331 - `Connector object`
321332
322333 - `connector_id: string`
323334
from line 338
327338
328339 Kind of resource the permission applies to.
329340
330 - `"connector"`
341 default: connector
331342
332 - `AllConnectors object { type }`
343 - `AllConnectors object`
333344
334345 - `type: "all_connectors"`
335346
336347 Kind of resource the permission applies to.
337348
338 - `"all_connectors"`
349 default: all_connectors
339350
340351 - `type: "rbac_role_permission"`
341352
from line 354
343354
344355 For RBAC Role Permissions, this is always `"rbac_role_permission"`.
345356
346 - `"rbac_role_permission"`
357 default: rbac_role_permission
347358
348359- `has_more: boolean`
349360
from line 365
354365 Opaque cursor for the next page. Pass as the `page` parameter on the next
355366 request.
356367
357### Example
368#### Example
358369
359```http
370```bash
360371curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
361372 -H 'anthropic-version: 2023-06-01' \
362373 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
363374```
364375
365#### Response
376##### Response (200)
366377
367378```json
368379{
from line 391
380391 "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
381392}
382393```
383
384## Domain Types
385
386### Rbac Role Permission
387
388- `RbacRolePermission object { action, resource, type }`
389
390 - `action: string`
391
392 Action the permission grants on the resource.
393
394 The vocabulary follows the resource: an `organization` grant carries a
395 product-feature entitlement (for example `chat`), an admin-panel
396 permission entitlement (`permission_*`), or a blanket capability-access
397 mode — `capability_access_all` grants every product-feature entitlement,
398 and `capability_access_all_ga` grants the generally-available subset as
399 it stands at permission-check time; neither mode grants model-access
400 entitlements. A consumer enumerating a role's per-feature grants should
401 treat a blanket row as granting every product-feature entitlement it
402 covers, or it will under-report the role's effective access. A `connector_tool` grant carries
403 a tool-access action (`use` or `always_allow`); a `connector_scope` grant
404 carries the scope action `grant` (the role may receive the named OAuth
405 scope when tokens are minted for the connector); `connector` and
406 `all_connectors` grants carry a tool-access action, the scope action, or
407 an authentication-method action (`interactive` or `managed`).
408
409 - `resource: object { organization_id, type } or object { connector_id, tool_name, type } or object { connector_id, scope, type } or 2 more`
410
411 What the permission applies to.
412
413 A tagged union: `type` names the kind of resource and determines which
414 identifier fields are present.
415
416 - `Organization object { organization_id, type }`
417
418 - `organization_id: string`
419
420 UUID of the organization the permission applies to.
421
422 - `type: "organization"`
423
424 Kind of resource the permission applies to.
425
426 - `"organization"`
427
428 - `ConnectorTool object { connector_id, tool_name, type }`
429
430 - `connector_id: string`
431
432 ID of the connector the permission applies to.
433
434 - `tool_name: string`
435
436 Published name of the connector tool the permission applies to.
437
438 When the published name contains characters outside `[a-zA-Z0-9_-]` (or
439 collides with a reserved form), it is server-encoded into a stable
440 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus
441 a hash — from which the published name is not recoverable.
442
443 - `type: "connector_tool"`
444
445 Kind of resource the permission applies to.
446
447 - `"connector_tool"`
448
449 - `ConnectorScope object { connector_id, scope, type }`
450
451 - `connector_id: string`
452
453 ID of the connector the permission applies to.
454
455 - `scope: string`
456
457 OAuth scope the permission names — the role may receive this scope when
458 tokens are minted for the connector.
459
460 Subject to the same encoding rule as `tool_name`: a scope containing
461 characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form)
462 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth
463 scopes routinely contain `:` and `/`, so most appear encoded.
464
465 - `type: "connector_scope"`
466
467 Kind of resource the permission applies to.
468
469 - `"connector_scope"`
470
471 - `Connector object { connector_id, type }`
472
473 - `connector_id: string`
474
475 ID of the connector the permission applies to.
476
477 - `type: "connector"`
478
479 Kind of resource the permission applies to.
480
481 - `"connector"`
482
483 - `AllConnectors object { type }`
484
485 - `type: "all_connectors"`
486
487 Kind of resource the permission applies to.
488
489 - `"all_connectors"`
490
491 - `type: "rbac_role_permission"`
492
493 Object type.
494
495 For RBAC Role Permissions, this is always `"rbac_role_permission"`.
496
497 - `"rbac_role_permission"`
498394
api/admin/rbac_roles/list Changed · +15 / -14 lines
# List RBAC Roles ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List RBAC Roles ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: List RBAC Roles
3url: https://platform.claude.com/docs/en/api/admin/rbac_roles/list
4---
1# List RBAC Roles
52
6## List RBAC Roles
3**GET** `/v1/organizations/rbac_roles`
74
8**get** `/v1/organizations/rbac_roles`
9
105List RBAC Roles in the organization.
116
127The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Query Parameters
9## Query parameters
1510
1611- `limit: optional number`
1712
from line 14
1914
2015 Defaults to `20`. Ranges from `1` to `1000`.
2116
17 default: 20, maximum: 1000, minimum: 1
18
2219- `page: optional string`
2320
2421 Optionally set to the `next_page` token from the previous response.
2522
26### Header Parameters
23## Headers
2724
2825- `"anthropic-beta": optional array of string`
2926
from line 28
3128
3229 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3330
34### Returns
31## Returns
3532
3633- `data: array of RbacRole`
3734
from line 40
4340
4441 RFC 3339 datetime string indicating when the RBAC Role was created.
4542
43 format: date-time
44
4645 - `name: string`
4746
4847 Name of the RBAC Role.
from line 52
5352
5453 For RBAC Roles, this is always `"rbac_role"`.
5554
56 - `"rbac_role"`
55 default: rbac_role
5756
5857 - `updated_at: string`
5958
6059 RFC 3339 datetime string indicating when the RBAC Role was last updated.
6160
61 format: date-time
62
6263- `has_more: boolean`
6364
6465 Indicates whether there are more results beyond this page.
from line 69
6869 Opaque cursor for the next page. Pass as the `page` parameter on the next
6970 request.
7071
71### Example
72## Example
7273
73```http
74```bash
7475curl https://api.anthropic.com/v1/organizations/rbac_roles \
7576 -H 'anthropic-version: 2023-06-01' \
7677 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
7778```
7879
79#### Response
80### Response (200)
8081
8182```json
8283{
api/admin/rbac_roles/permissions Changed · +42 / -45 lines
### Path parameters ### Query parameters ### Headers #### Response (200) ## Domain types ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types
from line 1
1---
2title: Permissions
3url: https://platform.claude.com/docs/en/api/admin/rbac_roles/permissions
4---
5
61# Permissions
72
83## List RBAC Role Permissions
94
10**get** `/v1/organizations/rbac_roles/{role_id}/permissions`
5**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`
116
127List the permissions an RBAC Role grants.
138
149The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
1510
16### Path Parameters
11### Path parameters
1712
1813- `role_id: string`
1914
2015 ID of the RBAC Role.
2116
22### Query Parameters
17### Query parameters
2318
2419- `limit: optional number`
2520
from line 22
2722
2823 Defaults to `20`. Ranges from `1` to `1000`.
2924
25 default: 20, maximum: 1000, minimum: 1
26
3027- `page: optional string`
3128
3229 Optionally set to the `next_page` token from the previous response.
3330
34### Header Parameters
31### Headers
3532
3633- `"anthropic-beta": optional array of string`
3734
from line 59
6259 `all_connectors` grants carry a tool-access action, the scope action, or
6360 an authentication-method action (`interactive` or `managed`).
6461
65 - `resource: object { organization_id, type } or object { connector_id, tool_name, type } or object { connector_id, scope, type } or 2 more`
62 - `resource: object or object or object or 2 more`
6663
6764 What the permission applies to.
6865
from line 66
6966 A tagged union: `type` names the kind of resource and determines which
7067 identifier fields are present.
7168
72 - `Organization object { organization_id, type }`
69 - `Organization object`
7370
7471 - `organization_id: string`
7572
from line 76
7976
8077 Kind of resource the permission applies to.
8178
82 - `"organization"`
79 default: organization
8380
84 - `ConnectorTool object { connector_id, tool_name, type }`
81 - `ConnectorTool object`
8582
8683 - `connector_id: string`
8784
from line 97
10097
10198 Kind of resource the permission applies to.
10299
103 - `"connector_tool"`
100 default: connector_tool
104101
105 - `ConnectorScope object { connector_id, scope, type }`
102 - `ConnectorScope object`
106103
107104 - `connector_id: string`
108105
from line 119
122119
123120 Kind of resource the permission applies to.
124121
125 - `"connector_scope"`
122 default: connector_scope
126123
127 - `Connector object { connector_id, type }`
124 - `Connector object`
128125
129126 - `connector_id: string`
130127
from line 131
134131
135132 Kind of resource the permission applies to.
136133
137 - `"connector"`
134 default: connector
138135
139 - `AllConnectors object { type }`
136 - `AllConnectors object`
140137
141138 - `type: "all_connectors"`
142139
143140 Kind of resource the permission applies to.
144141
145 - `"all_connectors"`
142 default: all_connectors
146143
147144 - `type: "rbac_role_permission"`
148145
from line 147
150147
151148 For RBAC Role Permissions, this is always `"rbac_role_permission"`.
152149
153 - `"rbac_role_permission"`
150 default: rbac_role_permission
154151
155152- `has_more: boolean`
156153
from line 160
163160
164161### Example
165162
166```http
163```bash
167164curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
168165 -H 'anthropic-version: 2023-06-01' \
169166 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
170167```
171168
172#### Response
169#### Response (200)
173170
174171```json
175172{
from line 185
188185}
189186```
190187
191## Domain Types
188## Domain types
192189
193190### Rbac Role Permission
194191
195- `RbacRolePermission object { action, resource, type }`
192- `RbacRolePermission object`
196193
197194 - `action: string`
198195
from line 210
213210 `all_connectors` grants carry a tool-access action, the scope action, or
214211 an authentication-method action (`interactive` or `managed`).
215212
216 - `resource: object { organization_id, type } or object { connector_id, tool_name, type } or object { connector_id, scope, type } or 2 more`
213 - `resource: object or object or object or 2 more`
217214
218215 What the permission applies to.
219216
from line 217
220217 A tagged union: `type` names the kind of resource and determines which
221218 identifier fields are present.
222219
223 - `Organization object { organization_id, type }`
220 - `Organization object`
224221
225222 - `organization_id: string`
226223
from line 227
230227
231228 Kind of resource the permission applies to.
232229
233 - `"organization"`
230 default: organization
234231
235 - `ConnectorTool object { connector_id, tool_name, type }`
232 - `ConnectorTool object`
236233
237234 - `connector_id: string`
238235
from line 248
251248
252249 Kind of resource the permission applies to.
253250
254 - `"connector_tool"`
251 default: connector_tool
255252
256 - `ConnectorScope object { connector_id, scope, type }`
253 - `ConnectorScope object`
257254
258255 - `connector_id: string`
259256
from line 270
273270
274271 Kind of resource the permission applies to.
275272
276 - `"connector_scope"`
273 default: connector_scope
277274
278 - `Connector object { connector_id, type }`
275 - `Connector object`
279276
280277 - `connector_id: string`
281278
from line 282
285282
286283 Kind of resource the permission applies to.
287284
288 - `"connector"`
285 default: connector
289286
290 - `AllConnectors object { type }`
287 - `AllConnectors object`
291288
292289 - `type: "all_connectors"`
293290
294291 Kind of resource the permission applies to.
295292
296 - `"all_connectors"`
293 default: all_connectors
297294
298295 - `type: "rbac_role_permission"`
299296
from line 298
301298
302299 For RBAC Role Permissions, this is always `"rbac_role_permission"`.
303300
304 - `"rbac_role_permission"`
301 default: rbac_role_permission
305302
api/admin/rbac_roles/permissions/list Changed · +23 / -26 lines
# List RBAC Role Permissions ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List RBAC Role Permissions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: List RBAC Role Permissions
3url: https://platform.claude.com/docs/en/api/admin/rbac_roles/permissions/list
4---
1# List RBAC Role Permissions
52
6## List RBAC Role Permissions
3**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`
74
8**get** `/v1/organizations/rbac_roles/{role_id}/permissions`
9
105List the permissions an RBAC Role grants.
116
127The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `role_id: string`
1712
1813 ID of the RBAC Role.
1914
20### Query Parameters
15## Query parameters
2116
2217- `limit: optional number`
2318
from line 20
2520
2621 Defaults to `20`. Ranges from `1` to `1000`.
2722
23 default: 20, maximum: 1000, minimum: 1
24
2825- `page: optional string`
2926
3027 Optionally set to the `next_page` token from the previous response.
3128
32### Header Parameters
29## Headers
3330
3431- `"anthropic-beta": optional array of string`
3532
from line 34
3734
3835 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3936
40### Returns
37## Returns
4138
4239- `data: array of RbacRolePermission`
4340
from line 57
6057 `all_connectors` grants carry a tool-access action, the scope action, or
6158 an authentication-method action (`interactive` or `managed`).
6259
63 - `resource: object { organization_id, type } or object { connector_id, tool_name, type } or object { connector_id, scope, type } or 2 more`
60 - `resource: object or object or object or 2 more`
6461
6562 What the permission applies to.
6663
from line 64
6764 A tagged union: `type` names the kind of resource and determines which
6865 identifier fields are present.
6966
70 - `Organization object { organization_id, type }`
67 - `Organization object`
7168
7269 - `organization_id: string`
7370
from line 74
7774
7875 Kind of resource the permission applies to.
7976
80 - `"organization"`
77 default: organization
8178
82 - `ConnectorTool object { connector_id, tool_name, type }`
79 - `ConnectorTool object`
8380
8481 - `connector_id: string`
8582
from line 95
9895
9996 Kind of resource the permission applies to.
10097
101 - `"connector_tool"`
98 default: connector_tool
10299
103 - `ConnectorScope object { connector_id, scope, type }`
100 - `ConnectorScope object`
104101
105102 - `connector_id: string`
106103
from line 117
120117
121118 Kind of resource the permission applies to.
122119
123 - `"connector_scope"`
120 default: connector_scope
124121
125 - `Connector object { connector_id, type }`
122 - `Connector object`
126123
127124 - `connector_id: string`
128125
from line 129
132129
133130 Kind of resource the permission applies to.
134131
135 - `"connector"`
132 default: connector
136133
137 - `AllConnectors object { type }`
134 - `AllConnectors object`
138135
139136 - `type: "all_connectors"`
140137
141138 Kind of resource the permission applies to.
142139
143 - `"all_connectors"`
140 default: all_connectors
144141
145142 - `type: "rbac_role_permission"`
146143
from line 145
148145
149146 For RBAC Role Permissions, this is always `"rbac_role_permission"`.
150147
151 - `"rbac_role_permission"`
148 default: rbac_role_permission
152149
153150- `has_more: boolean`
154151
from line 156
159156 Opaque cursor for the next page. Pass as the `page` parameter on the next
160157 request.
161158
162### Example
159## Example
163160
164```http
161```bash
165162curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
166163 -H 'anthropic-version: 2023-06-01' \
167164 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
168165```
169166
170#### Response
167### Response (200)
171168
172169```json
173170{
api/admin/rbac_roles/retrieve Changed · +14 / -15 lines
# Get RBAC Role ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get RBAC Role ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Get RBAC Role
3url: https://platform.claude.com/docs/en/api/admin/rbac_roles/retrieve
4---
1# Get RBAC Role
52
6## Get RBAC Role
3**GET** `/v1/organizations/rbac_roles/{role_id}`
74
8**get** `/v1/organizations/rbac_roles/{role_id}`
9
105Retrieve an RBAC Role by ID.
116
127The RBAC Roles API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
138
14### Path Parameters
9## Path parameters
1510
1611- `role_id: string`
1712
1813 ID of the RBAC Role.
1914
20### Header Parameters
15## Headers
2116
2217- `"anthropic-beta": optional array of string`
2318
from line 20
2520
2621 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2722
28### Returns
23## Returns
2924
30- `RbacRole object { id, created_at, name, 2 more }`
25- `RbacRole object`
3126
3227 - `id: string`
3328
from line 32
3732
3833 RFC 3339 datetime string indicating when the RBAC Role was created.
3934
35 format: date-time
36
4037 - `name: string`
4138
4239 Name of the RBAC Role.
from line 44
4744
4845 For RBAC Roles, this is always `"rbac_role"`.
4946
50 - `"rbac_role"`
47 default: rbac_role
5148
5249 - `updated_at: string`
5350
5451 RFC 3339 datetime string indicating when the RBAC Role was last updated.
5552
56### Example
53 format: date-time
5754
58```http
55## Example
56
57```bash
5958curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \
6059 -H 'anthropic-version: 2023-06-01' \
6160 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
6261```
6362
64#### Response
63### Response (200)
6564
6665```json
6766{
api/admin/service_accounts Changed · +125 / -176 lines
### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers #### Response (200) ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## Service Accounts › Workspaces ### Add Workspace To Service Account #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### List Workspaces For Service Account #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Remove Workspace From Service Account #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Workspaces ## Add Workspace To Service Account ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## List Workspaces For Service Account ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Remove Workspace From Service Account ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Workspace Create Response ### Workspace List Response ### Workspace Delete Response
from line 1
1---
2title: Service Accounts
3url: https://platform.claude.com/docs/en/api/admin/service_accounts
4---
5
61# Service Accounts
72
83## Create Service Account
94
10**post** `/v1/organizations/service_accounts`
5**POST** `/v1/organizations/service_accounts`
116
127Create a service account.
138
from line 15
2015an interactive credential (a user OAuth token or a Console session) — a
2116workload may only create `developer`-role service accounts.
2217
23### Header Parameters
18### Headers
2419
2520- `"anthropic-beta": optional array of string`
2621
from line 23
2823
2924 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3025
31### Body Parameters
26### Body parameters
3227
3328- `name: string`
3429
3530 Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
3631
32 maxLength: 255, minLength: 1
33
3734- `description: optional string or null`
3835
3936 Optional free-text description.
4037
38 maxLength: 2000
39
4140- `organization_role: optional "admin" or "developer"`
4241
4342 Org-level role. Defaults to `developer`.
from line 47
4847
4948### Returns
5049
51- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
50- `ServiceAccount object`
5251
5352 Named non-human identity within the caller's organization.
5453
from line 62
6362
6463 If set, this service account is archived.
6564
65 format: date-time
66
6667 - `archived_by_actor_id: string or null`
6768
6869 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 72
7172
7273 When this service account was created.
7374
75 format: date-time
76
7477 - `created_by_actor_id: string or null`
7578
7679 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 96
9396
9497 - `type: "service_account"`
9598
96 - `"service_account"`
99 default: service_account
97100
98101 - `updated_at: string`
99102
100103 When this service account was last updated.
101104
105 format: date-time
106
102107 - `updated_by_actor_id: string or null`
103108
104109 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
from line 110
105110
106111### Example
107112
108```http
113```bash
109114curl https://api.anthropic.com/v1/organizations/service_accounts \
110115 -H 'Content-Type: application/json' \
111116 -H 'anthropic-version: 2023-06-01' \
from line 120
115120 }'
116121```
117122
118#### Response
123#### Response (200)
119124
120125```json
121126{
from line 140
135140
136141## Get Service Account
137142
138**get** `/v1/organizations/service_accounts/{service_account_id}`
143**GET** `/v1/organizations/service_accounts/{service_account_id}`
139144
140145Retrieve a service account by its ID (`svac_...`).
141146
142### Path Parameters
147### Path parameters
143148
144149- `service_account_id: string`
145150
146151 ID of the service account.
147152
148### Header Parameters
153### Headers
149154
150155- `"anthropic-beta": optional array of string`
151156
from line 160
155160
156161### Returns
157162
158- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
163- `ServiceAccount object`
159164
160165 Named non-human identity within the caller's organization.
161166
from line 175
170175
171176 If set, this service account is archived.
172177
178 format: date-time
179
173180 - `archived_by_actor_id: string or null`
174181
175182 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 185
178185
179186 When this service account was created.
180187
188 format: date-time
189
181190 - `created_by_actor_id: string or null`
182191
183192 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 209
200209
201210 - `type: "service_account"`
202211
203 - `"service_account"`
212 default: service_account
204213
205214 - `updated_at: string`
206215
207216 When this service account was last updated.
208217
218 format: date-time
219
209220 - `updated_by_actor_id: string or null`
210221
211222 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
from line 223
212223
213224### Example
214225
215```http
226```bash
216227curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
217228 -H 'anthropic-version: 2023-06-01' \
218229 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
219230```
220231
221#### Response
232#### Response (200)
222233
223234```json
224235{
from line 249
238249
239250## List Service Accounts
240251
241**get** `/v1/organizations/service_accounts`
252**GET** `/v1/organizations/service_accounts`
242253
243254List service accounts in the caller's organization.
244255
from line 257
246257`next_page` cursor to paginate; set `include_archived=true` to include
247258archived service accounts.
248259
249### Query Parameters
260### Query parameters
250261
251262- `include_archived: optional boolean`
252263
253264 Include archived resources. Defaults to false.
254265
266 default: false
267
255268- `limit: optional number`
256269
257270 Number of results per page.
258271
272 default: 20, maximum: 100, minimum: 1
273
259274- `page: optional string`
260275
261276 Opaque cursor from a previous response's `next_page`.
262277
263### Header Parameters
278### Headers
264279
265280- `"anthropic-beta": optional array of string`
266281
from line 295
280295
281296 If set, this service account is archived.
282297
298 format: date-time
299
283300 - `archived_by_actor_id: string or null`
284301
285302 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 305
288305
289306 When this service account was created.
290307
308 format: date-time
309
291310 - `created_by_actor_id: string or null`
292311
293312 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 329
310329
311330 - `type: "service_account"`
312331
313 - `"service_account"`
332 default: service_account
314333
315334 - `updated_at: string`
316335
317336 When this service account was last updated.
318337
338 format: date-time
339
319340 - `updated_by_actor_id: string or null`
320341
321342 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
from line 347
326347
327348### Example
328349
329```http
350```bash
330351curl https://api.anthropic.com/v1/organizations/service_accounts \
331352 -H 'anthropic-version: 2023-06-01' \
332353 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
333354```
334355
335#### Response
356#### Response (200)
336357
337358```json
338359{
from line 378
357378
358379## Update Service Account
359380
360**post** `/v1/organizations/service_accounts/{service_account_id}`
381**POST** `/v1/organizations/service_accounts/{service_account_id}`
361382
362383Update a service account.
363384
from line 388
367388interactive credential (a user OAuth token or a Console session). Admin
368389API keys are not accepted.
369390
370### Path Parameters
391### Path parameters
371392
372393- `service_account_id: string`
373394
374395 ID of the service account to update.
375396
376### Header Parameters
397### Headers
377398
378399- `"anthropic-beta": optional array of string`
379400
from line 402
381402
382403 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
383404
384### Body Parameters
405### Body parameters
385406
386407- `description: optional string or null`
387408
388409 Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
389410
411 maxLength: 2000
412
390413- `organization_role: optional "admin" or "developer" or null`
391414
392415 Replaces the org-level role. Omit or send `null` to leave unchanged.
from line 420
397420
398421### Returns
399422
400- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
423- `ServiceAccount object`
401424
402425 Named non-human identity within the caller's organization.
403426
from line 435
412435
413436 If set, this service account is archived.
414437
438 format: date-time
439
415440 - `archived_by_actor_id: string or null`
416441
417442 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 445
420445
421446 When this service account was created.
422447
448 format: date-time
449
423450 - `created_by_actor_id: string or null`
424451
425452 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 469
442469
443470 - `type: "service_account"`
444471
445 - `"service_account"`
472 default: service_account
446473
447474 - `updated_at: string`
448475
449476 When this service account was last updated.
450477
478 format: date-time
479
451480 - `updated_by_actor_id: string or null`
452481
453482 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
from line 483
454483
455484### Example
456485
457```http
486```bash
458487curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
459488 -H 'Content-Type: application/json' \
460489 -H 'anthropic-version: 2023-06-01' \
from line 491
462491 -d '{}'
463492```
464493
465#### Response
494#### Response (200)
466495
467496```json
468497{
from line 511
482511
483512## Archive Service Account
484513
485**post** `/v1/organizations/service_accounts/{service_account_id}/archive`
514**POST** `/v1/organizations/service_accounts/{service_account_id}/archive`
486515
487516Archive a service account.
488517
from line 523
494523Requires an OAuth bearer or Console session; Admin API keys are not
495524accepted.
496525
497### Path Parameters
526### Path parameters
498527
499528- `service_account_id: string`
500529
501530 ID of the service account to archive.
502531
503### Header Parameters
532### Headers
504533
505534- `"anthropic-beta": optional array of string`
506535
from line 539
510539
511540### Returns
512541
513- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
542- `ServiceAccount object`
514543
515544 Named non-human identity within the caller's organization.
516545
from line 554
525554
526555 If set, this service account is archived.
527556
557 format: date-time
558
528559 - `archived_by_actor_id: string or null`
529560
530561 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 564
533564
534565 When this service account was created.
535566
567 format: date-time
568
536569 - `created_by_actor_id: string or null`
537570
538571 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 588
555588
556589 - `type: "service_account"`
557590
558 - `"service_account"`
591 default: service_account
559592
560593 - `updated_at: string`
561594
562595 When this service account was last updated.
563596
597 format: date-time
598
564599 - `updated_by_actor_id: string or null`
565600
566601 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
from line 602
567602
568603### Example
569604
570```http
605```bash
571606curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \
572607 -X POST \
573608 -H 'anthropic-version: 2023-06-01' \
from line 609
574609 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
575610```
576611
577#### Response
612#### Response (200)
578613
579614```json
580615{
from line 627
592627}
593628```
594629
595## Domain Types
630## Domain types
596631
597632### Service Account
598633
599- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
634- `ServiceAccount object`
600635
601636 Named non-human identity within the caller's organization.
602637
from line 646
611646
612647 If set, this service account is archived.
613648
649 format: date-time
650
614651 - `archived_by_actor_id: string or null`
615652
616653 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 656
619656
620657 When this service account was created.
621658
659 format: date-time
660
622661 - `created_by_actor_id: string or null`
623662
624663 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 680
641680
642681 - `type: "service_account"`
643682
644 - `"service_account"`
683 default: service_account
645684
646685 - `updated_at: string`
647686
648687 When this service account was last updated.
649688
689 format: date-time
690
650691 - `updated_by_actor_id: string or null`
651692
652693 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
653694
654# Workspaces
695## Service Accounts › Workspaces
655696
656## Add Workspace To Service Account
697### Add Workspace To Service Account
657698
658**post** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
699**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
659700
660701Add a service account to a workspace with the given `workspace_role`.
661702
from line 708
667708rejected. Requires an OAuth bearer or Console session; Admin API keys
668709are not accepted.
669710
670### Path Parameters
711#### Path parameters
671712
672713- `service_account_id: string`
673714
674715 ID of the service account.
675716
676### Header Parameters
717#### Headers
677718
678719- `"anthropic-beta": optional array of string`
679720
from line 722
681722
682723 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
683724
684### Body Parameters
725#### Body parameters
685726
686727- `workspace_id: string`
687728
from line 740
699740
700741 - `"workspace_user"`
701742
702### Returns
743#### Returns
703744
704745- `created_by_actor_id: string or null`
705746
from line 756
715756
716757- `type: "service_account_workspace_member"`
717758
718 - `"service_account_workspace_member"`
759 default: service_account_workspace_member
719760
720761- `workspace_id: string`
721762
from line 776
735776
736777 - `"workspace_user"`
737778
738### Example
779#### Example
739780
740```http
781```bash
741782curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
742783 -H 'Content-Type: application/json' \
743784 -H 'anthropic-version: 2023-06-01' \
from line 789
748789 }'
749790```
750791
751#### Response
792##### Response (200)
752793
753794```json
754795{
from line 802
761802}
762803```
763804
764## List Workspaces For Service Account
805### List Workspaces For Service Account
765806
766**get** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
807**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
767808
768809List the workspaces a service account is a member of.
769810
from line 818
777818the service account is active; an archived service account returns an
778819empty list.
779820
780### Path Parameters
821#### Path parameters
781822
782823- `service_account_id: string`
783824
784825 ID of the service account.
785826
786### Query Parameters
827#### Query parameters
787828
788829- `limit: optional number`
789830
790831 Number of results per page.
791832
833 default: 20, maximum: 100, minimum: 1
834
792835- `page: optional string`
793836
794837 Opaque cursor from a previous response's `next_page`.
795838
796### Header Parameters
839#### Headers
797840
798841- `"anthropic-beta": optional array of string`
799842
from line 844
801844
802845 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
803846
804### Returns
847#### Returns
805848
806- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }`
849- `data: array of object`
807850
808851 - `created_by_actor_id: string or null`
809852
from line 862
819862
820863 - `type: "service_account_workspace_member"`
821864
822 - `"service_account_workspace_member"`
865 default: service_account_workspace_member
823866
824867 - `workspace_id: string`
825868
from line 886
843886
844887 Opaque cursor for the next page, or null if no more results.
845888
846### Example
889#### Example
847890
848```http
891```bash
849892curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
850893 -H 'anthropic-version: 2023-06-01' \
851894 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
852895```
853896
854#### Response
897##### Response (200)
855898
856899```json
857900{
from line 912
869912}
870913```
871914
872## Remove Workspace From Service Account
915### Remove Workspace From Service Account
873916
874**delete** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
917**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
875918
876919Remove a service account from a workspace.
877920
from line 927
884927400. Requires an OAuth bearer or Console session; Admin API keys are not
885928accepted.
886929
887### Path Parameters
930#### Path parameters
888931
889932- `service_account_id: string`
890933
from line 937
894937
895938 ID of the workspace.
896939
897### Header Parameters
940#### Headers
898941
899942- `"anthropic-beta": optional array of string`
900943
from line 945
902945
903946 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
904947
905### Returns
948#### Returns
906949
907950- `service_account_id: string`
908951
from line 953
910953
911954- `type: "service_account_workspace_member_deleted"`
912955
913 - `"service_account_workspace_member_deleted"`
956 default: service_account_workspace_member_deleted
914957
915958- `workspace_id: string`
916959
917960 Tagged workspace ID (`wrkspc_...`) named in the delete request.
918961
919### Example
962#### Example
920963
921```http
964```bash
922965curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
923966 -X DELETE \
924967 -H 'anthropic-version: 2023-06-01' \
from line 968
925968 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
926969```
927970
928#### Response
971##### Response (200)
929972
930973```json
931974{
from line 977
934977 "workspace_id": "workspace_id"
935978}
936979```
937
938## Domain Types
939
940### Workspace Create Response
941
942- `WorkspaceCreateResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`
943
944 - `created_by_actor_id: string or null`
945
946 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
947
948 - `implicit: boolean or null`
949
950 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.
951
952 - `service_account_id: string`
953
954 Tagged service account ID (`svac_...`).
955
956 - `type: "service_account_workspace_member"`
957
958 - `"service_account_workspace_member"`
959
960 - `workspace_id: string`
961
962 Tagged workspace ID (`wrkspc_...`).
963
964 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
965
966 Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
967
968 - `"workspace_admin"`
969
970 - `"workspace_billing"`
971
972 - `"workspace_developer"`
973
974 - `"workspace_restricted_developer"`
975
976 - `"workspace_user"`
977
978### Workspace List Response
979
980- `WorkspaceListResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`
981
982 - `created_by_actor_id: string or null`
983
984 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
985
986 - `implicit: boolean or null`
987
988 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.
989
990 - `service_account_id: string`
991
992 Tagged service account ID (`svac_...`).
993
994 - `type: "service_account_workspace_member"`
995
996 - `"service_account_workspace_member"`
997
998 - `workspace_id: string`
999
1000 Tagged workspace ID (`wrkspc_...`).
1001
1002 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
1003
1004 Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
1005
1006 - `"workspace_admin"`
1007
1008 - `"workspace_billing"`
1009
1010 - `"workspace_developer"`
1011
1012 - `"workspace_restricted_developer"`
1013
1014 - `"workspace_user"`
1015
1016### Workspace Delete Response
1017
1018- `WorkspaceDeleteResponse object { service_account_id, type, workspace_id }`
1019
1020 - `service_account_id: string`
1021
1022 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
1023
1024 - `type: "service_account_workspace_member_deleted"`
1025
1026 - `"service_account_workspace_member_deleted"`
1027
1028 - `workspace_id: string`
1029
1030 Tagged workspace ID (`wrkspc_...`) named in the delete request.
1031980
api/admin/service_accounts/archive Changed · +16 / -15 lines
# Archive Service Account ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Archive Service Account ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Archive Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/archive
4---
1# Archive Service Account
52
6## Archive Service Account
3**POST** `/v1/organizations/service_accounts/{service_account_id}/archive`
74
8**post** `/v1/organizations/service_accounts/{service_account_id}/archive`
9
105Archive a service account.
116
127Idempotent; re-archiving returns the service account with its original
from line 12
1712Requires an OAuth bearer or Console session; Admin API keys are not
1813accepted.
1914
20### Path Parameters
15## Path parameters
2116
2217- `service_account_id: string`
2318
2419 ID of the service account to archive.
2520
26### Header Parameters
21## Headers
2722
2823- `"anthropic-beta": optional array of string`
2924
from line 26
3126
3227 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3328
34### Returns
29## Returns
3530
36- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
31- `ServiceAccount object`
3732
3833 Named non-human identity within the caller's organization.
3934
from line 43
4843
4944 If set, this service account is archived.
5045
46 format: date-time
47
5148 - `archived_by_actor_id: string or null`
5249
5350 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 53
5653
5754 When this service account was created.
5855
56 format: date-time
57
5958 - `created_by_actor_id: string or null`
6059
6160 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 77
7877
7978 - `type: "service_account"`
8079
81 - `"service_account"`
80 default: service_account
8281
8382 - `updated_at: string`
8483
8584 When this service account was last updated.
8685
86 format: date-time
87
8788 - `updated_by_actor_id: string or null`
8889
8990 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
9091
91### Example
92## Example
9293
93```http
94```bash
9495curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \
9596 -X POST \
9697 -H 'anthropic-version: 2023-06-01' \
from line 98
9798 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
9899```
99100
100#### Response
101### Response (200)
101102
102103```json
103104{
api/admin/service_accounts/create Changed · +20 / -15 lines
# Create Service Account ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Create Service Account ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Create Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/create
4---
1# Create Service Account
52
6## Create Service Account
3**POST** `/v1/organizations/service_accounts`
74
8**post** `/v1/organizations/service_accounts`
9
105Create a service account.
116
127A service account is a named workload identity that federation rules
from line 13
1813an interactive credential (a user OAuth token or a Console session) — a
1914workload may only create `developer`-role service accounts.
2015
21### Header Parameters
16## Headers
2217
2318- `"anthropic-beta": optional array of string`
2419
from line 21
2621
2722 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2823
29### Body Parameters
24## Body parameters
3025
3126- `name: string`
3227
3328 Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
3429
30 maxLength: 255, minLength: 1
31
3532- `description: optional string or null`
3633
3734 Optional free-text description.
3835
36 maxLength: 2000
37
3938- `organization_role: optional "admin" or "developer"`
4039
4140 Org-level role. Defaults to `developer`.
from line 43
4443
4544 - `"developer"`
4645
47### Returns
46## Returns
4847
49- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
48- `ServiceAccount object`
5049
5150 Named non-human identity within the caller's organization.
5251
from line 60
6160
6261 If set, this service account is archived.
6362
63 format: date-time
64
6465 - `archived_by_actor_id: string or null`
6566
6667 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 70
6970
7071 When this service account was created.
7172
73 format: date-time
74
7275 - `created_by_actor_id: string or null`
7376
7477 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 94
9194
9295 - `type: "service_account"`
9396
94 - `"service_account"`
97 default: service_account
9598
9699 - `updated_at: string`
97100
98101 When this service account was last updated.
99102
103 format: date-time
104
100105 - `updated_by_actor_id: string or null`
101106
102107 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
103108
104### Example
109## Example
105110
106```http
111```bash
107112curl https://api.anthropic.com/v1/organizations/service_accounts \
108113 -H 'Content-Type: application/json' \
109114 -H 'anthropic-version: 2023-06-01' \
from line 118
113118 }'
114119```
115120
116#### Response
121### Response (200)
117122
118123```json
119124{
api/admin/service_accounts/list Changed · +19 / -14 lines
# List Service Accounts ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Service Accounts ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: List Service Accounts
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/list
4---
1# List Service Accounts
52
6## List Service Accounts
3**GET** `/v1/organizations/service_accounts`
74
8**get** `/v1/organizations/service_accounts`
9
105List service accounts in the caller's organization.
116
127Results are ordered by creation time, newest first. Use `limit` and the
from line 8
138`next_page` cursor to paginate; set `include_archived=true` to include
149archived service accounts.
1510
16### Query Parameters
11## Query parameters
1712
1813- `include_archived: optional boolean`
1914
2015 Include archived resources. Defaults to false.
2116
17 default: false
18
2219- `limit: optional number`
2320
2421 Number of results per page.
2522
23 default: 20, maximum: 100, minimum: 1
24
2625- `page: optional string`
2726
2827 Opaque cursor from a previous response's `next_page`.
2928
30### Header Parameters
29## Headers
3130
3231- `"anthropic-beta": optional array of string`
3332
from line 34
3534
3635 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3736
38### Returns
37## Returns
3938
4039- `data: array of ServiceAccount`
4140
from line 46
4746
4847 If set, this service account is archived.
4948
49 format: date-time
50
5051 - `archived_by_actor_id: string or null`
5152
5253 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 56
5556
5657 When this service account was created.
5758
59 format: date-time
60
5861 - `created_by_actor_id: string or null`
5962
6063 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 80
7780
7881 - `type: "service_account"`
7982
80 - `"service_account"`
83 default: service_account
8184
8285 - `updated_at: string`
8386
8487 When this service account was last updated.
8588
89 format: date-time
90
8691 - `updated_by_actor_id: string or null`
8792
8893 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
from line 96
9196
9297 Opaque cursor for the next page, or null if no more results.
9398
94### Example
99## Example
95100
96```http
101```bash
97102curl https://api.anthropic.com/v1/organizations/service_accounts \
98103 -H 'anthropic-version: 2023-06-01' \
99104 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
100105```
101106
102#### Response
107### Response (200)
103108
104109```json
105110{
api/admin/service_accounts/retrieve Changed · +16 / -15 lines
# Get Service Account ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get Service Account ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Get Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/retrieve
4---
1# Get Service Account
52
6## Get Service Account
3**GET** `/v1/organizations/service_accounts/{service_account_id}`
74
8**get** `/v1/organizations/service_accounts/{service_account_id}`
9
105Retrieve a service account by its ID (`svac_...`).
116
12### Path Parameters
7## Path parameters
138
149- `service_account_id: string`
1510
1611 ID of the service account.
1712
18### Header Parameters
13## Headers
1914
2015- `"anthropic-beta": optional array of string`
2116
from line 18
2318
2419 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2520
26### Returns
21## Returns
2722
28- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
23- `ServiceAccount object`
2924
3025 Named non-human identity within the caller's organization.
3126
from line 35
4035
4136 If set, this service account is archived.
4237
38 format: date-time
39
4340 - `archived_by_actor_id: string or null`
4441
4542 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 45
4845
4946 When this service account was created.
5047
48 format: date-time
49
5150 - `created_by_actor_id: string or null`
5251
5352 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 69
7069
7170 - `type: "service_account"`
7271
73 - `"service_account"`
72 default: service_account
7473
7574 - `updated_at: string`
7675
7776 When this service account was last updated.
7877
78 format: date-time
79
7980 - `updated_by_actor_id: string or null`
8081
8182 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
8283
83### Example
84## Example
8485
85```http
86```bash
8687curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
8788 -H 'anthropic-version: 2023-06-01' \
8889 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
8990```
9091
91#### Response
92### Response (200)
9293
9394```json
9495{
api/admin/service_accounts/update Changed · +19 / -16 lines
# Update Service Account ## Path parameters ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Update Service Account ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Update Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/update
4---
1# Update Service Account
52
6## Update Service Account
3**POST** `/v1/organizations/service_accounts/{service_account_id}`
74
8**post** `/v1/organizations/service_accounts/{service_account_id}`
9
105Update a service account.
116
127Only `description` and `organization_role` are mutable; `name` cannot be
from line 10
1510interactive credential (a user OAuth token or a Console session). Admin
1611API keys are not accepted.
1712
18### Path Parameters
13## Path parameters
1914
2015- `service_account_id: string`
2116
2217 ID of the service account to update.
2318
24### Header Parameters
19## Headers
2520
2621- `"anthropic-beta": optional array of string`
2722
from line 24
2924
3025 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3126
32### Body Parameters
27## Body parameters
3328
3429- `description: optional string or null`
3530
3631 Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
3732
33 maxLength: 2000
34
3835- `organization_role: optional "admin" or "developer" or null`
3936
4037 Replaces the org-level role. Omit or send `null` to leave unchanged.
from line 40
4340
4441 - `"developer"`
4542
46### Returns
43## Returns
4744
48- `ServiceAccount object { id, archived_at, archived_by_actor_id, 8 more }`
45- `ServiceAccount object`
4946
5047 Named non-human identity within the caller's organization.
5148
from line 57
6057
6158 If set, this service account is archived.
6259
60 format: date-time
61
6362 - `archived_by_actor_id: string or null`
6463
6564 Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
from line 67
6867
6968 When this service account was created.
7069
70 format: date-time
71
7172 - `created_by_actor_id: string or null`
7273
7374 Tagged ID (`user_`/`svac_`) of the actor that created this service account.
from line 91
9091
9192 - `type: "service_account"`
9293
93 - `"service_account"`
94 default: service_account
9495
9596 - `updated_at: string`
9697
9798 When this service account was last updated.
9899
100 format: date-time
101
99102 - `updated_by_actor_id: string or null`
100103
101104 Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
102105
103### Example
106## Example
104107
105```http
108```bash
106109curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
107110 -H 'Content-Type: application/json' \
108111 -H 'anthropic-version: 2023-06-01' \
from line 113
110113 -d '{}'
111114```
112115
113#### Response
116### Response (200)
114117
115118```json
116119{
api/admin/service_accounts/workspaces Changed · +30 / -33 lines
### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types
from line 1
1---
2title: Workspaces
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces
4---
5
61# Workspaces
72
83## Add Workspace To Service Account
94
10**post** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
5**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
116
127Add a service account to a workspace with the given `workspace_role`.
138
from line 14
1914rejected. Requires an OAuth bearer or Console session; Admin API keys
2015are not accepted.
2116
22### Path Parameters
17### Path parameters
2318
2419- `service_account_id: string`
2520
2621 ID of the service account.
2722
28### Header Parameters
23### Headers
2924
3025- `"anthropic-beta": optional array of string`
3126
from line 28
3328
3429 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3530
36### Body Parameters
31### Body parameters
3732
3833- `workspace_id: string`
3934
from line 62
6762
6863- `type: "service_account_workspace_member"`
6964
70 - `"service_account_workspace_member"`
65 default: service_account_workspace_member
7166
7267- `workspace_id: string`
7368
from line 84
8984
9085### Example
9186
92```http
87```bash
9388curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
9489 -H 'Content-Type: application/json' \
9590 -H 'anthropic-version: 2023-06-01' \
from line 95
10095 }'
10196```
10297
103#### Response
98#### Response (200)
10499
105100```json
106101{
from line 110
115110
116111## List Workspaces For Service Account
117112
118**get** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
113**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
119114
120115List the workspaces a service account is a member of.
121116
from line 124
129124the service account is active; an archived service account returns an
130125empty list.
131126
132### Path Parameters
127### Path parameters
133128
134129- `service_account_id: string`
135130
136131 ID of the service account.
137132
138### Query Parameters
133### Query parameters
139134
140135- `limit: optional number`
141136
142137 Number of results per page.
143138
139 default: 20, maximum: 100, minimum: 1
140
144141- `page: optional string`
145142
146143 Opaque cursor from a previous response's `next_page`.
147144
148### Header Parameters
145### Headers
149146
150147- `"anthropic-beta": optional array of string`
151148
from line 152
155152
156153### Returns
157154
158- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }`
155- `data: array of object`
159156
160157 - `created_by_actor_id: string or null`
161158
from line 168
171168
172169 - `type: "service_account_workspace_member"`
173170
174 - `"service_account_workspace_member"`
171 default: service_account_workspace_member
175172
176173 - `workspace_id: string`
177174
from line 194
197194
198195### Example
199196
200```http
197```bash
201198curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
202199 -H 'anthropic-version: 2023-06-01' \
203200 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
204201```
205202
206#### Response
203#### Response (200)
207204
208205```json
209206{
from line 220
223220
224221## Remove Workspace From Service Account
225222
226**delete** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
223**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
227224
228225Remove a service account from a workspace.
229226
from line 233
236233400. Requires an OAuth bearer or Console session; Admin API keys are not
237234accepted.
238235
239### Path Parameters
236### Path parameters
240237
241238- `service_account_id: string`
242239
from line 243
246243
247244 ID of the workspace.
248245
249### Header Parameters
246### Headers
250247
251248- `"anthropic-beta": optional array of string`
252249
from line 259
262259
263260- `type: "service_account_workspace_member_deleted"`
264261
265 - `"service_account_workspace_member_deleted"`
262 default: service_account_workspace_member_deleted
266263
267264- `workspace_id: string`
268265
from line 267
270267
271268### Example
272269
273```http
270```bash
274271curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
275272 -X DELETE \
276273 -H 'anthropic-version: 2023-06-01' \
from line 274
277274 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
278275```
279276
280#### Response
277#### Response (200)
281278
282279```json
283280{
from line 284
287284}
288285```
289286
290## Domain Types
287## Domain types
291288
292289### Workspace Create Response
293290
294- `WorkspaceCreateResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`
291- `WorkspaceCreateResponse object`
295292
296293 - `created_by_actor_id: string or null`
297294
from line 304
307304
308305 - `type: "service_account_workspace_member"`
309306
310 - `"service_account_workspace_member"`
307 default: service_account_workspace_member
311308
312309 - `workspace_id: string`
313310
from line 326
329326
330327### Workspace List Response
331328
332- `WorkspaceListResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`
329- `WorkspaceListResponse object`
333330
334331 - `created_by_actor_id: string or null`
335332
from line 342
345342
346343 - `type: "service_account_workspace_member"`
347344
348 - `"service_account_workspace_member"`
345 default: service_account_workspace_member
349346
350347 - `workspace_id: string`
351348
from line 364
367364
368365### Workspace Delete Response
369366
370- `WorkspaceDeleteResponse object { service_account_id, type, workspace_id }`
367- `WorkspaceDeleteResponse object`
371368
372369 - `service_account_id: string`
373370
from line 372
375372
376373 - `type: "service_account_workspace_member_deleted"`
377374
378 - `"service_account_workspace_member_deleted"`
375 default: service_account_workspace_member_deleted
379376
380377 - `workspace_id: string`
381378
api/admin/service_accounts/workspaces/create Changed · +10 / -15 lines
# Add Workspace To Service Account ## Path parameters ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Add Workspace To Service Account ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Add Workspace To Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces/create
4---
1# Add Workspace To Service Account
52
6## Add Workspace To Service Account
3**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
74
8**post** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
9
105Add a service account to a workspace with the given `workspace_role`.
116
127Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from line 12
1712rejected. Requires an OAuth bearer or Console session; Admin API keys
1813are not accepted.
1914
20### Path Parameters
15## Path parameters
2116
2217- `service_account_id: string`
2318
2419 ID of the service account.
2520
26### Header Parameters
21## Headers
2722
2823- `"anthropic-beta": optional array of string`
2924
from line 26
3126
3227 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3328
34### Body Parameters
29## Body parameters
3530
3631- `workspace_id: string`
3732
from line 44
4944
5045 - `"workspace_user"`
5146
52### Returns
47## Returns
5348
5449- `created_by_actor_id: string or null`
5550
from line 60
6560
6661- `type: "service_account_workspace_member"`
6762
68 - `"service_account_workspace_member"`
63 default: service_account_workspace_member
6964
7065- `workspace_id: string`
7166
from line 80
8580
8681 - `"workspace_user"`
8782
88### Example
83## Example
8984
90```http
85```bash
9186curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
9287 -H 'Content-Type: application/json' \
9388 -H 'anthropic-version: 2023-06-01' \
from line 93
9893 }'
9994```
10095
101#### Response
96### Response (200)
10297
10398```json
10499{
api/admin/service_accounts/workspaces/delete Changed · +9 / -14 lines
# Remove Workspace From Service Account ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Remove Workspace From Service Account ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Remove Workspace From Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces/delete
4---
1# Remove Workspace From Service Account
52
6## Remove Workspace From Service Account
3**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
74
8**delete** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
9
105Remove a service account from a workspace.
116
127Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
from line 13
1813400. Requires an OAuth bearer or Console session; Admin API keys are not
1914accepted.
2015
21### Path Parameters
16## Path parameters
2217
2318- `service_account_id: string`
2419
from line 23
2823
2924 ID of the workspace.
3025
31### Header Parameters
26## Headers
3227
3328- `"anthropic-beta": optional array of string`
3429
from line 31
3631
3732 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
3833
39### Returns
34## Returns
4035
4136- `service_account_id: string`
4237
from line 39
4439
4540- `type: "service_account_workspace_member_deleted"`
4641
47 - `"service_account_workspace_member_deleted"`
42 default: service_account_workspace_member_deleted
4843
4944- `workspace_id: string`
5045
5146 Tagged workspace ID (`wrkspc_...`) named in the delete request.
5247
53### Example
48## Example
5449
55```http
50```bash
5651curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
5752 -X DELETE \
5853 -H 'anthropic-version: 2023-06-01' \
from line 54
5954 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
6055```
6156
62#### Response
57### Response (200)
6358
6459```json
6560{
api/admin/service_accounts/workspaces/list Changed · +13 / -16 lines
# List Workspaces For Service Account ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Workspaces For Service Account ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
1---
2title: List Workspaces For Service Account
3url: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces/list
4---
1# List Workspaces For Service Account
52
6## List Workspaces For Service Account
3**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
74
8**get** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
9
105List the workspaces a service account is a member of.
116
127Each entry includes the service account's `workspace_role` in that
from line 14
1914the service account is active; an archived service account returns an
2015empty list.
2116
22### Path Parameters
17## Path parameters
2318
2419- `service_account_id: string`
2520
2621 ID of the service account.
2722
28### Query Parameters
23## Query parameters
2924
3025- `limit: optional number`
3126
3227 Number of results per page.
3328
29 default: 20, maximum: 100, minimum: 1
30
3431- `page: optional string`
3532
3633 Opaque cursor from a previous response's `next_page`.
3734
38### Header Parameters
35## Headers
3936
4037- `"anthropic-beta": optional array of string`
4138
from line 40
4340
4441 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
4542
46### Returns
43## Returns
4744
48- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }`
45- `data: array of object`
4946
5047 - `created_by_actor_id: string or null`
5148
from line 58
6158
6259 - `type: "service_account_workspace_member"`
6360
64 - `"service_account_workspace_member"`
61 default: service_account_workspace_member
6562
6663 - `workspace_id: string`
6764
from line 82
8582
8683 Opaque cursor for the next page, or null if no more results.
8784
88### Example
85## Example
8986
90```http
87```bash
9188curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
9289 -H 'anthropic-version: 2023-06-01' \
9390 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
9491```
9592
96#### Response
93### Response (200)
9794
9895```json
9996{
api/admin/spend_limits Changed · +352 / -707 lines
### Body parameters #### Response (200) ### Path parameters #### Response (200) ### Path parameters #### Response (200) ### Query parameters #### Response (200) ## Domain types ## Spend Limits › Increase Requests ### List Spend Limit Increase Requests #### Query parameters #### Returns #### Example ##### Response (200) ### Get Spend Limit Increase Request #### Path parameters #### Returns #### Example ##### Response (200) ### Approve Spend Limit Increase Request #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Deny Spend Limit Increase Request #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Body Parameters #### Response ### Path Parameters #### Response ### Path Parameters #### Response ### Query Parameters #### Response ## Domain Types # Increase Requests ## List Spend Limit Increase Requests ### Query Parameters #### Response ## Get Spend Limit Increase Request ### Path Parameters #### Response ## Approve Spend Limit Increase Request ### Path Parameters ### Body Parameters #### Response ## Deny Spend Limit Increase Request ### Path Parameters ### Body Parameters #### Response ## Domain Types ### Spend Limit Increase Request ### Increase Request Approve Response
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Spend Limits
3url: https://platform.claude.com/docs/en/api/admin/spend_limits
4---
5
61# Spend Limits
72
83## Set Spend Limit
94
10**post** `/v1/organizations/spend_limits`
5**POST** `/v1/organizations/spend_limits`
116
127Set a per-user spend limit override.
138
from line 10
1510overwrites it in place. Only `scope.type: "user"` is accepted; seat-tier,
1611group, and organization-level defaults are configured in claude.ai.
1712
18### Body Parameters
13### Body parameters
1914
2015- `amount: string or null`
2116
2217 Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is $500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply.
2318
24- `scope: object { type, user_id }`
19- `scope: object`
2520
2621 - `type: "user"`
2722
28 - `"user"`
23 default: user
2924
3025 - `user_id: string`
3126
from line 34
3934
4035### Returns
4136
42- `SpendLimit object { id, amount, created_at, 5 more }`
37- `SpendLimit object`
4338
4439 - `id: string`
4540
from line 44
4944
5045 - `created_at: string`
5146
47 format: date-time
48
5249 - `currency: string`
5350
5451 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 58
6158
6259 - `"weekly"`
6360
64 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
65
66 - `User object { type, user_id }`
61 - `scope: object or object or object or 2 more`
62
63 - `User object`
6764
6865 - `type: "user"`
6966
70 - `"user"`
67 default: user
7168
7269 - `user_id: string`
7370
74 - `SeatTier object { seat_tier, type }`
71 - `SeatTier object`
7572
7673 - `seat_tier: string`
7774
7875 - `type: "seat_tier"`
7976
80 - `"seat_tier"`
81
82 - `RbacGroup object { rbac_group_id, type }`
77 default: seat_tier
78
79 - `RbacGroup object`
8380
8481 - `rbac_group_id: string`
8582
8683 - `type: "rbac_group"`
8784
88 - `"rbac_group"`
89
90 - `OrganizationService object { service, type }`
85 default: rbac_group
86
87 - `OrganizationService object`
9188
9289 - `service: string`
9390
9491 - `type: "organization_service"`
9592
96 - `"organization_service"`
97
98 - `Organization object { type }`
93 default: organization_service
94
95 - `Organization object`
9996
10097 - `type: "organization"`
10198
102 - `"organization"`
99 default: organization
103100
104101 - `type: "spend_limit"`
105102
106 - `"spend_limit"`
103 default: spend_limit
107104
108105 - `updated_at: string`
109106
107 format: date-time
108
110109### Example
111110
112```http
111```bash
113112curl https://api.anthropic.com/v1/organizations/spend_limits \
114113 -H 'Content-Type: application/json' \
115114 -H 'anthropic-version: 2023-06-01' \
from line 123
124123 }'
125124```
126125
127#### Response
126#### Response (200)
128127
129128```json
130129{
from line 143
144143
145144## Get Spend Limit
146145
147**get** `/v1/organizations/spend_limits/{spend_limit_id}`
146**GET** `/v1/organizations/spend_limits/{spend_limit_id}`
148147
149148Retrieve a spend limit by ID.
150149
151### Path Parameters
150### Path parameters
152151
153152- `spend_limit_id: string`
154153
from line 155
156155
157156### Returns
158157
159- `SpendLimit object { id, amount, created_at, 5 more }`
158- `SpendLimit object`
160159
161160 - `id: string`
162161
from line 165
166165
167166 - `created_at: string`
168167
168 format: date-time
169
169170 - `currency: string`
170171
171172 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 179
178179
179180 - `"weekly"`
180181
181 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
182
183 - `User object { type, user_id }`
182 - `scope: object or object or object or 2 more`
183
184 - `User object`
184185
185186 - `type: "user"`
186187
187 - `"user"`
188 default: user
188189
189190 - `user_id: string`
190191
191 - `SeatTier object { seat_tier, type }`
192 - `SeatTier object`
192193
193194 - `seat_tier: string`
194195
195196 - `type: "seat_tier"`
196197
197 - `"seat_tier"`
198
199 - `RbacGroup object { rbac_group_id, type }`
198 default: seat_tier
199
200 - `RbacGroup object`
200201
201202 - `rbac_group_id: string`
202203
203204 - `type: "rbac_group"`
204205
205 - `"rbac_group"`
206
207 - `OrganizationService object { service, type }`
206 default: rbac_group
207
208 - `OrganizationService object`
208209
209210 - `service: string`
210211
211212 - `type: "organization_service"`
212213
213 - `"organization_service"`
214
215 - `Organization object { type }`
214 default: organization_service
215
216 - `Organization object`
216217
217218 - `type: "organization"`
218219
219 - `"organization"`
220 default: organization
220221
221222 - `type: "spend_limit"`
222223
223 - `"spend_limit"`
224 default: spend_limit
224225
225226 - `updated_at: string`
226227
228 format: date-time
229
227230### Example
228231
229```http
232```bash
230233curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
231234 -H 'anthropic-version: 2023-06-01' \
232235 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
233236```
234237
235#### Response
238#### Response (200)
236239
237240```json
238241{
from line 255
252255
253256## Delete Spend Limit
254257
255**delete** `/v1/organizations/spend_limits/{spend_limit_id}`
258**DELETE** `/v1/organizations/spend_limits/{spend_limit_id}`
256259
257260Delete a per-user spend limit override.
258261
from line 263
260263Seat-tier, group, and organization-level rows cannot be deleted via
261264this endpoint.
262265
263### Path Parameters
266### Path parameters
264267
265268- `spend_limit_id: string`
266269
from line 275
272275
273276- `type: "spend_limit_deleted"`
274277
275 - `"spend_limit_deleted"`
278 default: spend_limit_deleted
276279
277280### Example
278281
279```http
282```bash
280283curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
281284 -X DELETE \
282285 -H 'anthropic-version: 2023-06-01' \
283286 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
284287```
285288
286#### Response
289#### Response (200)
287290
288291```json
289292{
from line 297
294297
295298## List Effective Spend Limits
296299
297**get** `/v1/organizations/spend_limits/effective`
300**GET** `/v1/organizations/spend_limits/effective`
298301
299302List each member's effective spend limit and period-to-date spend.
300303
from line 305
302305for, with the `source` scope the spend limit was inherited from.
303306Paginates by member, so a member's periods never split across pages.
304307
305### Query Parameters
308### Query parameters
306309
307310- `limit: optional number`
308311
312 default: 20, maximum: 1000, minimum: 1
313
309314- `page: optional string`
310315
311316- `period: optional array of string`
312317
318 maxItems: 3
319
313320- `user_ids: optional array of string`
314321
322 maxItems: 100
323
315324### Returns
316325
317326- `data: array of SpendSummary`
318327
319 - `actor: object { deleted, email_address, name, 2 more }`
328 - `actor: object`
320329
321330 A user within the organization. `name` and `email_address` are
322331 null when the underlying account is unavailable or has been deleted;
from line 333
324333
325334 - `deleted: boolean`
326335
336 default: false
337
327338 - `email_address: string or null`
328339
329340 - `name: string or null`
330341
331342 - `type: "user_actor"`
332343
333 - `"user_actor"`
344 default: user_actor
334345
335346 - `user_id: string`
336347
from line 365
354365
355366 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
356367
357 - `scope: object { type, user_id }`
368 - `scope: object`
358369
359370 - `type: "user"`
360371
361 - `"user"`
372 default: user
362373
363374 - `user_id: string`
364375
365 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
366
367 - `User object { type, user_id }`
376 - `source: object or object or object or 2 more`
377
378 - `User object`
368379
369380 - `type: "user"`
370381
371 - `"user"`
382 default: user
372383
373384 - `user_id: string`
374385
375 - `SeatTier object { seat_tier, type }`
386 - `SeatTier object`
376387
377388 - `seat_tier: string`
378389
379390 - `type: "seat_tier"`
380391
381 - `"seat_tier"`
382
383 - `RbacGroup object { rbac_group_id, type }`
392 default: seat_tier
393
394 - `RbacGroup object`
384395
385396 - `rbac_group_id: string`
386397
387398 - `type: "rbac_group"`
388399
389 - `"rbac_group"`
390
391 - `OrganizationService object { service, type }`
400 default: rbac_group
401
402 - `OrganizationService object`
392403
393404 - `service: string`
394405
395406 - `type: "organization_service"`
396407
397 - `"organization_service"`
398
399 - `Organization object { type }`
408 default: organization_service
409
410 - `Organization object`
400411
401412 - `type: "organization"`
402413
403 - `"organization"`
414 default: organization
404415
405416 - `spend_limit_id: string`
406417
from line 419
408419
409420### Example
410421
411```http
422```bash
412423curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
413424 -H 'anthropic-version: 2023-06-01' \
414425 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
415426```
416427
417#### Response
428#### Response (200)
418429
419430```json
420431{
from line 457
446457}
447458```
448459
449## Domain Types
460## Domain types
450461
451462### Spend Limit
452463
453- `SpendLimit object { id, amount, created_at, 5 more }`
464- `SpendLimit object`
454465
455466 - `id: string`
456467
from line 471
460471
461472 - `created_at: string`
462473
474 format: date-time
475
463476 - `currency: string`
464477
465478 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 485
472485
473486 - `"weekly"`
474487
475 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
476
477 - `User object { type, user_id }`
488 - `scope: object or object or object or 2 more`
489
490 - `User object`
478491
479492 - `type: "user"`
480493
481 - `"user"`
494 default: user
482495
483496 - `user_id: string`
484497
485 - `SeatTier object { seat_tier, type }`
498 - `SeatTier object`
486499
487500 - `seat_tier: string`
488501
489502 - `type: "seat_tier"`
490503
491 - `"seat_tier"`
492
493 - `RbacGroup object { rbac_group_id, type }`
504 default: seat_tier
505
506 - `RbacGroup object`
494507
495508 - `rbac_group_id: string`
496509
497510 - `type: "rbac_group"`
498511
499 - `"rbac_group"`
500
501 - `OrganizationService object { service, type }`
512 default: rbac_group
513
514 - `OrganizationService object`
502515
503516 - `service: string`
504517
505518 - `type: "organization_service"`
506519
507 - `"organization_service"`
508
509 - `Organization object { type }`
520 default: organization_service
521
522 - `Organization object`
510523
511524 - `type: "organization"`
512525
513 - `"organization"`
526 default: organization
514527
515528 - `type: "spend_limit"`
516529
517 - `"spend_limit"`
530 default: spend_limit
518531
519532 - `updated_at: string`
520533
534 format: date-time
535
521536### Spend Summary
522537
523- `SpendSummary object { actor, amount, currency, 5 more }`
538- `SpendSummary object`
524539
525540 Per-member effective-limit report row (GET /spend_limits/effective).
526541
527 - `actor: object { deleted, email_address, name, 2 more }`
542 - `actor: object`
528543
529544 A user within the organization. `name` and `email_address` are
530545 null when the underlying account is unavailable or has been deleted;
from line 547
532547
533548 - `deleted: boolean`
534549
550 default: false
551
535552 - `email_address: string or null`
536553
537554 - `name: string or null`
538555
539556 - `type: "user_actor"`
540557
541 - `"user_actor"`
558 default: user_actor
542559
543560 - `user_id: string`
544561
from line 579
562579
563580 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
564581
565 - `scope: object { type, user_id }`
582 - `scope: object`
566583
567584 - `type: "user"`
568585
569 - `"user"`
586 default: user
570587
571588 - `user_id: string`
572589
573 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
574
575 - `User object { type, user_id }`
590 - `source: object or object or object or 2 more`
591
592 - `User object`
576593
577594 - `type: "user"`
578595
579 - `"user"`
596 default: user
580597
581598 - `user_id: string`
582599
583 - `SeatTier object { seat_tier, type }`
600 - `SeatTier object`
584601
585602 - `seat_tier: string`
586603
587604 - `type: "seat_tier"`
588605
589 - `"seat_tier"`
590
591 - `RbacGroup object { rbac_group_id, type }`
606 default: seat_tier
607
608 - `RbacGroup object`
592609
593610 - `rbac_group_id: string`
594611
595612 - `type: "rbac_group"`
596613
597 - `"rbac_group"`
598
599 - `OrganizationService object { service, type }`
614 default: rbac_group
615
616 - `OrganizationService object`
600617
601618 - `service: string`
602619
603620 - `type: "organization_service"`
604621
605 - `"organization_service"`
606
607 - `Organization object { type }`
622 default: organization_service
623
624 - `Organization object`
608625
609626 - `type: "organization"`
610627
611 - `"organization"`
628 default: organization
612629
613630 - `spend_limit_id: string`
614631
615632### Spend Limit Delete Response
616633
617- `SpendLimitDeleteResponse object { id, type }`
634- `SpendLimitDeleteResponse object`
618635
619636 - `id: string`
620637
621638 - `type: "spend_limit_deleted"`
622639
623 - `"spend_limit_deleted"`
624
625# Increase Requests
626
627## List Spend Limit Increase Requests
628
629**get** `/v1/organizations/spend_limit_increase_requests`
640 default: spend_limit_deleted
641
642## Spend Limits › Increase Requests
643
644### List Spend Limit Increase Requests
645
646**GET** `/v1/organizations/spend_limit_increase_requests`
630647
631648List spend limit increase requests, most recent first.
632649
633650Pending requests include a live `spend_summary` for the requester.
634651Requests whose requester is no longer a member are excluded.
635652
636### Query Parameters
653#### Query parameters
637654
638655- `actor_ids: optional array of string`
639656
from line 658
641658
642659- `limit: optional number`
643660
661 default: 20, maximum: 1000, minimum: 1
662
644663- `page: optional string`
645664
646665 Opaque cursor from a previous response's `next_page`.
from line 674
655674
656675 - `"pending"`
657676
658### Returns
677#### Returns
659678
660679- `data: array of SpendLimitIncreaseRequest`
661680
662681 - `id: string`
663682
664 - `actor: object { deleted, email_address, name, 2 more }`
683 - `actor: object`
665684
666685 A user within the organization. `name` and `email_address` are
667686 null when the underlying account is unavailable or has been deleted;
from line 688
669688
670689 - `deleted: boolean`
671690
691 default: false
692
672693 - `email_address: string or null`
673694
674695 - `name: string or null`
675696
676697 - `type: "user_actor"`
677698
678 - `"user_actor"`
699 default: user_actor
679700
680701 - `user_id: string`
681702
682703 - `created_at: string`
683704
705 format: date-time
706
684707 - `period: "daily" or "monthly" or "weekly"`
685708
686709 - `"daily"`
from line 714
691714
692715 - `resolved_at: string or null`
693716
694 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
717 format: date-time
718
719 - `resolved_by: object or object or null`
695720
696721 A user within the organization. `name` and `email_address` are
697722 null when the underlying account is unavailable or has been deleted;
698723 `deleted` is true only for deleted accounts.
699724
700 - `UserActor object { deleted, email_address, name, 2 more }`
725 - `UserActor object`
701726
702727 A user within the organization. `name` and `email_address` are
703728 null when the underlying account is unavailable or has been deleted;
from line 730
705730
706731 - `deleted: boolean`
707732
733 default: false
734
708735 - `email_address: string or null`
709736
710737 - `name: string or null`
711738
712739 - `type: "user_actor"`
713740
714 - `"user_actor"`
741 default: user_actor
715742
716743 - `user_id: string`
717744
718 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
745 - `ScopedAPIKeyActor object`
719746
720747 A scoped Admin API key acting on behalf of the organization.
721748
from line 750
723750
724751 - `type: "scoped_api_key_actor"`
725752
726 - `"scoped_api_key_actor"`
753 default: scoped_api_key_actor
727754
728755 - `spend_summary: SpendSummary or null`
729756
730757 Per-member effective-limit report row (GET /spend_limits/effective).
731758
732 - `actor: object { deleted, email_address, name, 2 more }`
759 - `actor: object`
733760
734761 A user within the organization. `name` and `email_address` are
735762 null when the underlying account is unavailable or has been deleted;
from line 764
737764
738765 - `deleted: boolean`
739766
767 default: false
768
740769 - `email_address: string or null`
741770
742771 - `name: string or null`
743772
744773 - `type: "user_actor"`
745774
746 - `"user_actor"`
775 default: user_actor
747776
748777 - `user_id: string`
749778
from line 796
767796
768797 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
769798
770 - `scope: object { type, user_id }`
799 - `scope: object`
771800
772801 - `type: "user"`
773802
774 - `"user"`
803 default: user
775804
776805 - `user_id: string`
777806
778 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
779
780 - `User object { type, user_id }`
807 - `source: object or object or object or 2 more`
808
809 - `User object`
781810
782811 - `type: "user"`
783812
784 - `"user"`
813 default: user
785814
786815 - `user_id: string`
787816
788 - `SeatTier object { seat_tier, type }`
817 - `SeatTier object`
789818
790819 - `seat_tier: string`
791820
792821 - `type: "seat_tier"`
793822
794 - `"seat_tier"`
795
796 - `RbacGroup object { rbac_group_id, type }`
823 default: seat_tier
824
825 - `RbacGroup object`
797826
798827 - `rbac_group_id: string`
799828
800829 - `type: "rbac_group"`
801830
802 - `"rbac_group"`
803
804 - `OrganizationService object { service, type }`
831 default: rbac_group
832
833 - `OrganizationService object`
805834
806835 - `service: string`
807836
808837 - `type: "organization_service"`
809838
810 - `"organization_service"`
811
812 - `Organization object { type }`
839 default: organization_service
840
841 - `Organization object`
813842
814843 - `type: "organization"`
815844
816 - `"organization"`
845 default: organization
817846
818847 - `spend_limit_id: string`
819848
from line 856
827856
828857 - `type: "spend_limit_increase_request"`
829858
830 - `"spend_limit_increase_request"`
859 default: spend_limit_increase_request
831860
832861- `next_page: string or null`
833862
834### Example
835
836```http
863#### Example
864
865```bash
837866curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \
838867 -H 'anthropic-version: 2023-06-01' \
839868 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
840869```
841870
842#### Response
871##### Response (200)
843872
844873```json
845874{
from line 922
893922}
894923```
895924
896## Get Spend Limit Increase Request
897
898**get** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}`
925### Get Spend Limit Increase Request
926
927**GET** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}`
899928
900929Retrieve a spend limit increase request.
901930
902931While `pending`, the response includes a live `spend_summary` for the
903932requester at the request's period.
904933
905### Path Parameters
934#### Path parameters
906935
907936- `spend_limit_increase_request_id: string`
908937
909938 ID of the spend limit increase request.
910939
911### Returns
912
913- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`
940#### Returns
941
942- `SpendLimitIncreaseRequest object`
914943
915944 - `id: string`
916945
917 - `actor: object { deleted, email_address, name, 2 more }`
946 - `actor: object`
918947
919948 A user within the organization. `name` and `email_address` are
920949 null when the underlying account is unavailable or has been deleted;
from line 951
922951
923952 - `deleted: boolean`
924953
954 default: false
955
925956 - `email_address: string or null`
926957
927958 - `name: string or null`
928959
929960 - `type: "user_actor"`
930961
931 - `"user_actor"`
962 default: user_actor
932963
933964 - `user_id: string`
934965
935966 - `created_at: string`
936967
968 format: date-time
969
937970 - `period: "daily" or "monthly" or "weekly"`
938971
939972 - `"daily"`
from line 977
944977
945978 - `resolved_at: string or null`
946979
947 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
980 format: date-time
981
982 - `resolved_by: object or object or null`
948983
949984 A user within the organization. `name` and `email_address` are
950985 null when the underlying account is unavailable or has been deleted;
951986 `deleted` is true only for deleted accounts.
952987
953 - `UserActor object { deleted, email_address, name, 2 more }`
988 - `UserActor object`
954989
955990 A user within the organization. `name` and `email_address` are
956991 null when the underlying account is unavailable or has been deleted;
from line 993
958993
959994 - `deleted: boolean`
960995
996 default: false
997
961998 - `email_address: string or null`
962999
9631000 - `name: string or null`
9641001
9651002 - `type: "user_actor"`
9661003
967 - `"user_actor"`
1004 default: user_actor
9681005
9691006 - `user_id: string`
9701007
971 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1008 - `ScopedAPIKeyActor object`
9721009
9731010 A scoped Admin API key acting on behalf of the organization.
9741011
from line 1013
9761013
9771014 - `type: "scoped_api_key_actor"`
9781015
979 - `"scoped_api_key_actor"`
1016 default: scoped_api_key_actor
9801017
9811018 - `spend_summary: SpendSummary or null`
9821019
9831020 Per-member effective-limit report row (GET /spend_limits/effective).
9841021
985 - `actor: object { deleted, email_address, name, 2 more }`
1022 - `actor: object`
9861023
9871024 A user within the organization. `name` and `email_address` are
9881025 null when the underlying account is unavailable or has been deleted;
from line 1027
9901027
9911028 - `deleted: boolean`
9921029
1030 default: false
1031
9931032 - `email_address: string or null`
9941033
9951034 - `name: string or null`
9961035
9971036 - `type: "user_actor"`
9981037
999 - `"user_actor"`
1038 default: user_actor
10001039
10011040 - `user_id: string`
10021041
from line 1059
10201059
10211060 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
10221061
1023 - `scope: object { type, user_id }`
1062 - `scope: object`
10241063
10251064 - `type: "user"`
10261065
1027 - `"user"`
1066 default: user
10281067
10291068 - `user_id: string`
10301069
1031 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1032
1033 - `User object { type, user_id }`
1070 - `source: object or object or object or 2 more`
1071
1072 - `User object`
10341073
10351074 - `type: "user"`
10361075
1037 - `"user"`
1076 default: user
10381077
10391078 - `user_id: string`
10401079
1041 - `SeatTier object { seat_tier, type }`
1080 - `SeatTier object`
10421081
10431082 - `seat_tier: string`
10441083
10451084 - `type: "seat_tier"`
10461085
1047 - `"seat_tier"`
1048
1049 - `RbacGroup object { rbac_group_id, type }`
1086 default: seat_tier
1087
1088 - `RbacGroup object`
10501089
10511090 - `rbac_group_id: string`
10521091
10531092 - `type: "rbac_group"`
10541093
1055 - `"rbac_group"`
1056
1057 - `OrganizationService object { service, type }`
1094 default: rbac_group
1095
1096 - `OrganizationService object`
10581097
10591098 - `service: string`
10601099
10611100 - `type: "organization_service"`
10621101
1063 - `"organization_service"`
1064
1065 - `Organization object { type }`
1102 default: organization_service
1103
1104 - `Organization object`
10661105
10671106 - `type: "organization"`
10681107
1069 - `"organization"`
1108 default: organization
10701109
10711110 - `spend_limit_id: string`
10721111
from line 1119
10801119
10811120 - `type: "spend_limit_increase_request"`
10821121
1083 - `"spend_limit_increase_request"`
1084
1085### Example
1086
1087```http
1122 default: spend_limit_increase_request
1123
1124#### Example
1125
1126```bash
10881127curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
10891128 -H 'anthropic-version: 2023-06-01' \
10901129 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
10911130```
10921131
1093#### Response
1132##### Response (200)
10941133
10951134```json
10961135{
from line 1178
11391178}
11401179```
11411180
1142## Approve Spend Limit Increase Request
1143
1144**post** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve`
1181### Approve Spend Limit Increase Request
1182
1183**POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve`
11451184
11461185Approve a pending spend limit increase request.
11471186
from line 1189
11501189the member was blocked on. Anthropic emails the requester unless
11511190`suppress_notification` is set.
11521191
1153### Path Parameters
1192#### Path parameters
11541193
11551194- `spend_limit_increase_request_id: string`
11561195
11571196 ID of the spend limit increase request.
11581197
1159### Body Parameters
1198#### Body parameters
11601199
11611200- `amount: string`
11621201
from line 1211
11721211
11731212- `suppress_notification: optional boolean`
11741213
1175### Returns
1214#### Returns
11761215
11771216- `id: string`
11781217
1179- `actor: object { deleted, email_address, name, 2 more }`
1218- `actor: object`
11801219
11811220 A user within the organization. `name` and `email_address` are
11821221 null when the underlying account is unavailable or has been deleted;
from line 1223
11841223
11851224 - `deleted: boolean`
11861225
1226 default: false
1227
11871228 - `email_address: string or null`
11881229
11891230 - `name: string or null`
11901231
11911232 - `type: "user_actor"`
11921233
1193 - `"user_actor"`
1234 default: user_actor
11941235
11951236 - `user_id: string`
11961237
11971238- `created_at: string`
11981239
1240 format: date-time
1241
11991242- `period: "daily" or "monthly" or "weekly"`
12001243
12011244 - `"daily"`
from line 1249
12061249
12071250- `resolved_at: string or null`
12081251
1209- `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
1252 format: date-time
1253
1254- `resolved_by: object or object or null`
12101255
12111256 A user within the organization. `name` and `email_address` are
12121257 null when the underlying account is unavailable or has been deleted;
12131258 `deleted` is true only for deleted accounts.
12141259
1215 - `UserActor object { deleted, email_address, name, 2 more }`
1260 - `UserActor object`
12161261
12171262 A user within the organization. `name` and `email_address` are
12181263 null when the underlying account is unavailable or has been deleted;
from line 1265
12201265
12211266 - `deleted: boolean`
12221267
1268 default: false
1269
12231270 - `email_address: string or null`
12241271
12251272 - `name: string or null`
12261273
12271274 - `type: "user_actor"`
12281275
1229 - `"user_actor"`
1276 default: user_actor
12301277
12311278 - `user_id: string`
12321279
1233 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1280 - `ScopedAPIKeyActor object`
12341281
12351282 A scoped Admin API key acting on behalf of the organization.
12361283
from line 1285
12381285
12391286 - `type: "scoped_api_key_actor"`
12401287
1241 - `"scoped_api_key_actor"`
1288 default: scoped_api_key_actor
12421289
12431290- `spend_limit: SpendLimit`
12441291
from line 1297
12501297
12511298 - `created_at: string`
12521299
1300 format: date-time
1301
12531302 - `currency: string`
12541303
12551304 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 1311
12621311
12631312 - `"weekly"`
12641313
1265 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1266
1267 - `User object { type, user_id }`
1314 - `scope: object or object or object or 2 more`
1315
1316 - `User object`
12681317
12691318 - `type: "user"`
12701319
1271 - `"user"`
1320 default: user
12721321
12731322 - `user_id: string`
12741323
1275 - `SeatTier object { seat_tier, type }`
1324 - `SeatTier object`
12761325
12771326 - `seat_tier: string`
12781327
12791328 - `type: "seat_tier"`
12801329
1281 - `"seat_tier"`
1282
1283 - `RbacGroup object { rbac_group_id, type }`
1330 default: seat_tier
1331
1332 - `RbacGroup object`
12841333
12851334 - `rbac_group_id: string`
12861335
12871336 - `type: "rbac_group"`
12881337
1289 - `"rbac_group"`
1290
1291 - `OrganizationService object { service, type }`
1338 default: rbac_group
1339
1340 - `OrganizationService object`
12921341
12931342 - `service: string`
12941343
12951344 - `type: "organization_service"`
12961345
1297 - `"organization_service"`
1298
1299 - `Organization object { type }`
1346 default: organization_service
1347
1348 - `Organization object`
13001349
13011350 - `type: "organization"`
13021351
1303 - `"organization"`
1352 default: organization
13041353
13051354 - `type: "spend_limit"`
13061355
1307 - `"spend_limit"`
1356 default: spend_limit
13081357
13091358 - `updated_at: string`
13101359
1360 format: date-time
1361
13111362- `spend_summary: SpendSummary or null`
13121363
13131364 Per-member effective-limit report row (GET /spend_limits/effective).
13141365
1315 - `actor: object { deleted, email_address, name, 2 more }`
1366 - `actor: object`
13161367
13171368 A user within the organization. `name` and `email_address` are
13181369 null when the underlying account is unavailable or has been deleted;
from line 1371
13201371
13211372 - `deleted: boolean`
13221373
1374 default: false
1375
13231376 - `email_address: string or null`
13241377
13251378 - `name: string or null`
13261379
13271380 - `type: "user_actor"`
13281381
1329 - `"user_actor"`
1382 default: user_actor
13301383
13311384 - `user_id: string`
13321385
from line 1403
13501403
13511404 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
13521405
1353 - `scope: object { type, user_id }`
1406 - `scope: object`
13541407
13551408 - `type: "user"`
13561409
1357 - `"user"`
1410 default: user
13581411
13591412 - `user_id: string`
13601413
1361 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1362
1363 - `User object { type, user_id }`
1414 - `source: object or object or object or 2 more`
1415
1416 - `User object`
13641417
13651418 - `type: "user"`
13661419
1367 - `"user"`
1420 default: user
13681421
13691422 - `user_id: string`
13701423
1371 - `SeatTier object { seat_tier, type }`
1424 - `SeatTier object`
13721425
13731426 - `seat_tier: string`
13741427
13751428 - `type: "seat_tier"`
13761429
1377 - `"seat_tier"`
1378
1379 - `RbacGroup object { rbac_group_id, type }`
1430 default: seat_tier
1431
1432 - `RbacGroup object`
13801433
13811434 - `rbac_group_id: string`
13821435
13831436 - `type: "rbac_group"`
13841437
1385 - `"rbac_group"`
1386
1387 - `OrganizationService object { service, type }`
1438 default: rbac_group
1439
1440 - `OrganizationService object`
13881441
13891442 - `service: string`
13901443
13911444 - `type: "organization_service"`
13921445
1393 - `"organization_service"`
1394
1395 - `Organization object { type }`
1446 default: organization_service
1447
1448 - `Organization object`
13961449
13971450 - `type: "organization"`
13981451
1399 - `"organization"`
1452 default: organization
14001453
14011454 - `spend_limit_id: string`
14021455
from line 1463
14101463
14111464- `type: "spend_limit_increase_request"`
14121465
1413 - `"spend_limit_increase_request"`
1414
1415### Example
1416
1417```http
1466 default: spend_limit_increase_request
1467
1468#### Example
1469
1470```bash
14181471curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
14191472 -H 'Content-Type: application/json' \
14201473 -H 'anthropic-version: 2023-06-01' \
from line 1478
14251478 }'
14261479```
14271480
1428#### Response
1481##### Response (200)
14291482
14301483```json
14311484{
from line 1540
14871540}
14881541```
14891542
1490## Deny Spend Limit Increase Request
1491
1492**post** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny`
1543### Deny Spend Limit Increase Request
1544
1545**POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny`
14931546
14941547Deny a pending spend limit increase request.
14951548
14961549Idempotent on `denied`; denying an already-`approved` request returns
14971550400. Anthropic emails the requester unless `suppress_notification` is set.
14981551
1499### Path Parameters
1552#### Path parameters
15001553
15011554- `spend_limit_increase_request_id: string`
15021555
15031556 ID of the spend limit increase request.
15041557
1505### Body Parameters
1558#### Body parameters
15061559
15071560- `suppress_notification: optional boolean`
15081561
1509### Returns
1510
1511- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`
1562#### Returns
1563
1564- `SpendLimitIncreaseRequest object`
15121565
15131566 - `id: string`
15141567
1515 - `actor: object { deleted, email_address, name, 2 more }`
1568 - `actor: object`
15161569
15171570 A user within the organization. `name` and `email_address` are
15181571 null when the underlying account is unavailable or has been deleted;
from line 1573
15201573
15211574 - `deleted: boolean`
15221575
1576 default: false
1577
15231578 - `email_address: string or null`
15241579
15251580 - `name: string or null`
15261581
15271582 - `type: "user_actor"`
15281583
1529 - `"user_actor"`
1584 default: user_actor
15301585
15311586 - `user_id: string`
15321587
15331588 - `created_at: string`
15341589
1590 format: date-time
1591
15351592 - `period: "daily" or "monthly" or "weekly"`
15361593
15371594 - `"daily"`
from line 1599
15421599
15431600 - `resolved_at: string or null`
15441601
1545 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
1602 format: date-time
1603
1604 - `resolved_by: object or object or null`
15461605
15471606 A user within the organization. `name` and `email_address` are
15481607 null when the underlying account is unavailable or has been deleted;
15491608 `deleted` is true only for deleted accounts.
15501609
1551 - `UserActor object { deleted, email_address, name, 2 more }`
1610 - `UserActor object`
15521611
15531612 A user within the organization. `name` and `email_address` are
15541613 null when the underlying account is unavailable or has been deleted;
from line 1615
15561615
15571616 - `deleted: boolean`
15581617
1618 default: false
1619
15591620 - `email_address: string or null`
15601621
15611622 - `name: string or null`
15621623
15631624 - `type: "user_actor"`
15641625
1565 - `"user_actor"`
1626 default: user_actor
15661627
15671628 - `user_id: string`
15681629
1569 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1630 - `ScopedAPIKeyActor object`
15701631
15711632 A scoped Admin API key acting on behalf of the organization.
15721633
from line 1635
15741635
15751636 - `type: "scoped_api_key_actor"`
15761637
1577 - `"scoped_api_key_actor"`
1638 default: scoped_api_key_actor
15781639
15791640 - `spend_summary: SpendSummary or null`
15801641
15811642 Per-member effective-limit report row (GET /spend_limits/effective).
15821643
1583 - `actor: object { deleted, email_address, name, 2 more }`
1644 - `actor: object`
15841645
15851646 A user within the organization. `name` and `email_address` are
15861647 null when the underlying account is unavailable or has been deleted;
from line 1649
15881649
15891650 - `deleted: boolean`
15901651
1652 default: false
1653
15911654 - `email_address: string or null`
15921655
15931656 - `name: string or null`
15941657
15951658 - `type: "user_actor"`
15961659
1597 - `"user_actor"`
1660 default: user_actor
15981661
15991662 - `user_id: string`
16001663
from line 1681
16181681
16191682 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
16201683
1621 - `scope: object { type, user_id }`
1684 - `scope: object`
16221685
16231686 - `type: "user"`
16241687
1625 - `"user"`
1688 default: user
16261689
16271690 - `user_id: string`
16281691
1629 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1630
1631 - `User object { type, user_id }`
1692 - `source: object or object or object or 2 more`
1693
1694 - `User object`
16321695
16331696 - `type: "user"`
16341697
1635 - `"user"`
1698 default: user
16361699
16371700 - `user_id: string`
16381701
1639 - `SeatTier object { seat_tier, type }`
1702 - `SeatTier object`
16401703
16411704 - `seat_tier: string`
16421705
16431706 - `type: "seat_tier"`
16441707
1645 - `"seat_tier"`
1646
1647 - `RbacGroup object { rbac_group_id, type }`
1708 default: seat_tier
1709
1710 - `RbacGroup object`
16481711
16491712 - `rbac_group_id: string`
16501713
16511714 - `type: "rbac_group"`
16521715
1653 - `"rbac_group"`
1654
1655 - `OrganizationService object { service, type }`
1716 default: rbac_group
1717
1718 - `OrganizationService object`
16561719
16571720 - `service: string`
16581721
16591722 - `type: "organization_service"`
16601723
1661 - `"organization_service"`
1662
1663 - `Organization object { type }`
1724 default: organization_service
1725
1726 - `Organization object`
16641727
16651728 - `type: "organization"`
16661729
1667 - `"organization"`
1730 default: organization
16681731
16691732 - `spend_limit_id: string`
16701733
from line 1741
16781741
16791742 - `type: "spend_limit_increase_request"`
16801743
1681 - `"spend_limit_increase_request"`
1682
1683### Example
1684
1685```http
1744 default: spend_limit_increase_request
1745
1746#### Example
1747
1748```bash
16861749curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
16871750 -H 'Content-Type: application/json' \
16881751 -H 'anthropic-version: 2023-06-01' \
from line 1753
16901753 -d '{}'
16911754```
16921755
1693#### Response
1756##### Response (200)
16941757
16951758```json
16961759{
from line 1801
17381801 "type": "spend_limit_increase_request"
17391802}
17401803```
1741
1742## Domain Types
1743
1744### Spend Limit Increase Request
1745
1746- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`
1747
1748 - `id: string`
1749
1750 - `actor: object { deleted, email_address, name, 2 more }`
1751
1752 A user within the organization. `name` and `email_address` are
1753 null when the underlying account is unavailable or has been deleted;
1754 `deleted` is true only for deleted accounts.
1755
1756 - `deleted: boolean`
1757
1758 - `email_address: string or null`
1759
1760 - `name: string or null`
1761
1762 - `type: "user_actor"`
1763
1764 - `"user_actor"`
1765
1766 - `user_id: string`
1767
1768 - `created_at: string`
1769
1770 - `period: "daily" or "monthly" or "weekly"`
1771
1772 - `"daily"`
1773
1774 - `"monthly"`
1775
1776 - `"weekly"`
1777
1778 - `resolved_at: string or null`
1779
1780 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
1781
1782 A user within the organization. `name` and `email_address` are
1783 null when the underlying account is unavailable or has been deleted;
1784 `deleted` is true only for deleted accounts.
1785
1786 - `UserActor object { deleted, email_address, name, 2 more }`
1787
1788 A user within the organization. `name` and `email_address` are
1789 null when the underlying account is unavailable or has been deleted;
1790 `deleted` is true only for deleted accounts.
1791
1792 - `deleted: boolean`
1793
1794 - `email_address: string or null`
1795
1796 - `name: string or null`
1797
1798 - `type: "user_actor"`
1799
1800 - `"user_actor"`
1801
1802 - `user_id: string`
1803
1804 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1805
1806 A scoped Admin API key acting on behalf of the organization.
1807
1808 - `scoped_api_key_id: string`
1809
1810 - `type: "scoped_api_key_actor"`
1811
1812 - `"scoped_api_key_actor"`
1813
1814 - `spend_summary: SpendSummary or null`
1815
1816 Per-member effective-limit report row (GET /spend_limits/effective).
1817
1818 - `actor: object { deleted, email_address, name, 2 more }`
1819
1820 A user within the organization. `name` and `email_address` are
1821 null when the underlying account is unavailable or has been deleted;
1822 `deleted` is true only for deleted accounts.
1823
1824 - `deleted: boolean`
1825
1826 - `email_address: string or null`
1827
1828 - `name: string or null`
1829
1830 - `type: "user_actor"`
1831
1832 - `"user_actor"`
1833
1834 - `user_id: string`
1835
1836 - `amount: string or null`
1837
1838 Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member.
1839
1840 - `currency: string`
1841
1842 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1843
1844 - `period: "daily" or "monthly" or "weekly"`
1845
1846 - `"daily"`
1847
1848 - `"monthly"`
1849
1850 - `"weekly"`
1851
1852 - `period_to_date_spend: string`
1853
1854 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
1855
1856 - `scope: object { type, user_id }`
1857
1858 - `type: "user"`
1859
1860 - `"user"`
1861
1862 - `user_id: string`
1863
1864 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1865
1866 - `User object { type, user_id }`
1867
1868 - `type: "user"`
1869
1870 - `"user"`
1871
1872 - `user_id: string`
1873
1874 - `SeatTier object { seat_tier, type }`
1875
1876 - `seat_tier: string`
1877
1878 - `type: "seat_tier"`
1879
1880 - `"seat_tier"`
1881
1882 - `RbacGroup object { rbac_group_id, type }`
1883
1884 - `rbac_group_id: string`
1885
1886 - `type: "rbac_group"`
1887
1888 - `"rbac_group"`
1889
1890 - `OrganizationService object { service, type }`
1891
1892 - `service: string`
1893
1894 - `type: "organization_service"`
1895
1896 - `"organization_service"`
1897
1898 - `Organization object { type }`
1899
1900 - `type: "organization"`
1901
1902 - `"organization"`
1903
1904 - `spend_limit_id: string`
1905
1906 - `status: "approved" or "denied" or "pending"`
1907
1908 - `"approved"`
1909
1910 - `"denied"`
1911
1912 - `"pending"`
1913
1914 - `type: "spend_limit_increase_request"`
1915
1916 - `"spend_limit_increase_request"`
1917
1918### Increase Request Approve Response
1919
1920- `IncreaseRequestApproveResponse object { id, actor, created_at, 7 more }`
1921
1922 - `id: string`
1923
1924 - `actor: object { deleted, email_address, name, 2 more }`
1925
1926 A user within the organization. `name` and `email_address` are
1927 null when the underlying account is unavailable or has been deleted;
1928 `deleted` is true only for deleted accounts.
1929
1930 - `deleted: boolean`
1931
1932 - `email_address: string or null`
1933
1934 - `name: string or null`
1935
1936 - `type: "user_actor"`
1937
1938 - `"user_actor"`
1939
1940 - `user_id: string`
1941
1942 - `created_at: string`
1943
1944 - `period: "daily" or "monthly" or "weekly"`
1945
1946 - `"daily"`
1947
1948 - `"monthly"`
1949
1950 - `"weekly"`
1951
1952 - `resolved_at: string or null`
1953
1954 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
1955
1956 A user within the organization. `name` and `email_address` are
1957 null when the underlying account is unavailable or has been deleted;
1958 `deleted` is true only for deleted accounts.
1959
1960 - `UserActor object { deleted, email_address, name, 2 more }`
1961
1962 A user within the organization. `name` and `email_address` are
1963 null when the underlying account is unavailable or has been deleted;
1964 `deleted` is true only for deleted accounts.
1965
1966 - `deleted: boolean`
1967
1968 - `email_address: string or null`
1969
1970 - `name: string or null`
1971
1972 - `type: "user_actor"`
1973
1974 - `"user_actor"`
1975
1976 - `user_id: string`
1977
1978 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1979
1980 A scoped Admin API key acting on behalf of the organization.
1981
1982 - `scoped_api_key_id: string`
1983
1984 - `type: "scoped_api_key_actor"`
1985
1986 - `"scoped_api_key_actor"`
1987
1988 - `spend_limit: SpendLimit`
1989
1990 - `id: string`
1991
1992 - `amount: string or null`
1993
1994 Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies.
1995
1996 - `created_at: string`
1997
1998 - `currency: string`
1999
2000 ISO 4217 code of the organization's billing currency; the unit for `amount`.
2001
2002 - `period: "daily" or "monthly" or "weekly"`
2003
2004 - `"daily"`
2005
2006 - `"monthly"`
2007
2008 - `"weekly"`
2009
2010 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
2011
2012 - `User object { type, user_id }`
2013
2014 - `type: "user"`
2015
2016 - `"user"`
2017
2018 - `user_id: string`
2019
2020 - `SeatTier object { seat_tier, type }`
2021
2022 - `seat_tier: string`
2023
2024 - `type: "seat_tier"`
2025
2026 - `"seat_tier"`
2027
2028 - `RbacGroup object { rbac_group_id, type }`
2029
2030 - `rbac_group_id: string`
2031
2032 - `type: "rbac_group"`
2033
2034 - `"rbac_group"`
2035
2036 - `OrganizationService object { service, type }`
2037
2038 - `service: string`
2039
2040 - `type: "organization_service"`
2041
2042 - `"organization_service"`
2043
2044 - `Organization object { type }`
2045
2046 - `type: "organization"`
2047
2048 - `"organization"`
2049
2050 - `type: "spend_limit"`
2051
2052 - `"spend_limit"`
2053
2054 - `updated_at: string`
2055
2056 - `spend_summary: SpendSummary or null`
2057
2058 Per-member effective-limit report row (GET /spend_limits/effective).
2059
2060 - `actor: object { deleted, email_address, name, 2 more }`
2061
2062 A user within the organization. `name` and `email_address` are
2063 null when the underlying account is unavailable or has been deleted;
2064 `deleted` is true only for deleted accounts.
2065
2066 - `deleted: boolean`
2067
2068 - `email_address: string or null`
2069
2070 - `name: string or null`
2071
2072 - `type: "user_actor"`
2073
2074 - `"user_actor"`
2075
2076 - `user_id: string`
2077
2078 - `amount: string or null`
2079
2080 Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member.
2081
2082 - `currency: string`
2083
2084 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
2085
2086 - `period: "daily" or "monthly" or "weekly"`
2087
2088 - `"daily"`
2089
2090 - `"monthly"`
2091
2092 - `"weekly"`
2093
2094 - `period_to_date_spend: string`
2095
2096 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
2097
2098 - `scope: object { type, user_id }`
2099
2100 - `type: "user"`
2101
2102 - `"user"`
2103
2104 - `user_id: string`
2105
2106 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
2107
2108 - `User object { type, user_id }`
2109
2110 - `type: "user"`
2111
2112 - `"user"`
2113
2114 - `user_id: string`
2115
2116 - `SeatTier object { seat_tier, type }`
2117
2118 - `seat_tier: string`
2119
2120 - `type: "seat_tier"`
2121
2122 - `"seat_tier"`
2123
2124 - `RbacGroup object { rbac_group_id, type }`
2125
2126 - `rbac_group_id: string`
2127
2128 - `type: "rbac_group"`
2129
2130 - `"rbac_group"`
2131
2132 - `OrganizationService object { service, type }`
2133
2134 - `service: string`
2135
2136 - `type: "organization_service"`
2137
2138 - `"organization_service"`
2139
2140 - `Organization object { type }`
2141
2142 - `type: "organization"`
2143
2144 - `"organization"`
2145
2146 - `spend_limit_id: string`
2147
2148 - `status: "approved" or "denied" or "pending"`
2149
2150 - `"approved"`
2151
2152 - `"denied"`
2153
2154 - `"pending"`
2155
2156 - `type: "spend_limit_increase_request"`
2157
2158 - `"spend_limit_increase_request"`
21591804
api/admin/spend_limits/create Changed · +26 / -27 lines
# Set Spend Limit ## Body parameters ## Returns ## Example ### Response (200) ## Set Spend Limit ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Set Spend Limit
3url: https://platform.claude.com/docs/en/api/admin/spend_limits/create
4---
1# Set Spend Limit
52
6## Set Spend Limit
3**POST** `/v1/organizations/spend_limits`
74
8**post** `/v1/organizations/spend_limits`
9
105Set a per-user spend limit override.
116
127Upsert keyed on (scope, period): setting a limit that already exists
from line 8
138overwrites it in place. Only `scope.type: "user"` is accepted; seat-tier,
149group, and organization-level defaults are configured in claude.ai.
1510
16### Body Parameters
11## Body parameters
1712
1813- `amount: string or null`
1914
2015 Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is $500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply.
2116
22- `scope: object { type, user_id }`
17- `scope: object`
2318
2419 - `type: "user"`
2520
26 - `"user"`
21 default: user
2722
2823 - `user_id: string`
2924
from line 30
3530
3631 - `"weekly"`
3732
38### Returns
33## Returns
3934
40- `SpendLimit object { id, amount, created_at, 5 more }`
35- `SpendLimit object`
4136
4237 - `id: string`
4338
from line 42
4742
4843 - `created_at: string`
4944
45 format: date-time
46
5047 - `currency: string`
5148
5249 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 56
5956
6057 - `"weekly"`
6158
62 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
59 - `scope: object or object or object or 2 more`
6360
64 - `User object { type, user_id }`
61 - `User object`
6562
6663 - `type: "user"`
6764
68 - `"user"`
65 default: user
6966
7067 - `user_id: string`
7168
72 - `SeatTier object { seat_tier, type }`
69 - `SeatTier object`
7370
7471 - `seat_tier: string`
7572
7673 - `type: "seat_tier"`
7774
78 - `"seat_tier"`
75 default: seat_tier
7976
80 - `RbacGroup object { rbac_group_id, type }`
77 - `RbacGroup object`
8178
8279 - `rbac_group_id: string`
8380
8481 - `type: "rbac_group"`
8582
86 - `"rbac_group"`
83 default: rbac_group
8784
88 - `OrganizationService object { service, type }`
85 - `OrganizationService object`
8986
9087 - `service: string`
9188
9289 - `type: "organization_service"`
9390
94 - `"organization_service"`
91 default: organization_service
9592
96 - `Organization object { type }`
93 - `Organization object`
9794
9895 - `type: "organization"`
9996
100 - `"organization"`
97 default: organization
10198
10299 - `type: "spend_limit"`
103100
104 - `"spend_limit"`
101 default: spend_limit
105102
106103 - `updated_at: string`
107104
108### Example
105 format: date-time
109106
110```http
107## Example
108
109```bash
111110curl https://api.anthropic.com/v1/organizations/spend_limits \
112111 -H 'Content-Type: application/json' \
113112 -H 'anthropic-version: 2023-06-01' \
from line 121
122121 }'
123122```
124123
125#### Response
124### Response (200)
126125
127126```json
128127{
api/admin/spend_limits/delete Changed · +8 / -13 lines
# Delete Spend Limit ## Path parameters ## Returns ## Example ### Response (200) ## Delete Spend Limit ### Path Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Delete Spend Limit
3url: https://platform.claude.com/docs/en/api/admin/spend_limits/delete
4---
1# Delete Spend Limit
52
6## Delete Spend Limit
3**DELETE** `/v1/organizations/spend_limits/{spend_limit_id}`
74
8**delete** `/v1/organizations/spend_limits/{spend_limit_id}`
9
105Delete a per-user spend limit override.
116
127The member falls back to any inherited spend limit at that period.
from line 8
138Seat-tier, group, and organization-level rows cannot be deleted via
149this endpoint.
1510
16### Path Parameters
11## Path parameters
1712
1813- `spend_limit_id: string`
1914
2015 ID of the Spend Limit.
2116
22### Returns
17## Returns
2318
2419- `id: string`
2520
2621- `type: "spend_limit_deleted"`
2722
28 - `"spend_limit_deleted"`
23 default: spend_limit_deleted
2924
30### Example
25## Example
3126
32```http
27```bash
3328curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
3429 -X DELETE \
3530 -H 'anthropic-version: 2023-06-01' \
from line 31
3631 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
3732```
3833
39#### Response
34### Response (200)
4035
4136```json
4237{
api/admin/spend_limits/increase_requests Changed · +287 / -222 lines
### Query parameters #### Response (200) ### Path parameters #### Response (200) ### Path parameters ### Body parameters #### Response (200) ### Path parameters ### Body parameters #### Response (200) ## Domain types ### Query Parameters #### Response ### Path Parameters #### Response ### Path Parameters ### Body Parameters #### Response ### Path Parameters ### Body Parameters #### Response ## Domain Types
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Increase Requests
3url: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests
4---
5
61# Increase Requests
72
83## List Spend Limit Increase Requests
94
10**get** `/v1/organizations/spend_limit_increase_requests`
5**GET** `/v1/organizations/spend_limit_increase_requests`
116
127List spend limit increase requests, most recent first.
138
149Pending requests include a live `spend_summary` for the requester.
1510Requests whose requester is no longer a member are excluded.
1611
17### Query Parameters
12### Query parameters
1813
1914- `actor_ids: optional array of string`
2015
from line 17
2217
2318- `limit: optional number`
2419
20 default: 20, maximum: 1000, minimum: 1
21
2522- `page: optional string`
2623
2724 Opaque cursor from a previous response's `next_page`.
from line 39
4239
4340 - `id: string`
4441
45 - `actor: object { deleted, email_address, name, 2 more }`
42 - `actor: object`
4643
4744 A user within the organization. `name` and `email_address` are
4845 null when the underlying account is unavailable or has been deleted;
from line 47
5047
5148 - `deleted: boolean`
5249
50 default: false
51
5352 - `email_address: string or null`
5453
5554 - `name: string or null`
5655
5756 - `type: "user_actor"`
5857
59 - `"user_actor"`
58 default: user_actor
6059
6160 - `user_id: string`
6261
6362 - `created_at: string`
6463
64 format: date-time
65
6566 - `period: "daily" or "monthly" or "weekly"`
6667
6768 - `"daily"`
from line 73
7273
7374 - `resolved_at: string or null`
7475
75 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
76 format: date-time
77
78 - `resolved_by: object or object or null`
7679
7780 A user within the organization. `name` and `email_address` are
7881 null when the underlying account is unavailable or has been deleted;
7982 `deleted` is true only for deleted accounts.
8083
81 - `UserActor object { deleted, email_address, name, 2 more }`
84 - `UserActor object`
8285
8386 A user within the organization. `name` and `email_address` are
8487 null when the underlying account is unavailable or has been deleted;
from line 89
8689
8790 - `deleted: boolean`
8891
92 default: false
93
8994 - `email_address: string or null`
9095
9196 - `name: string or null`
9297
9398 - `type: "user_actor"`
9499
95 - `"user_actor"`
100 default: user_actor
96101
97102 - `user_id: string`
98103
99 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
104 - `ScopedAPIKeyActor object`
100105
101106 A scoped Admin API key acting on behalf of the organization.
102107
from line 109
104109
105110 - `type: "scoped_api_key_actor"`
106111
107 - `"scoped_api_key_actor"`
112 default: scoped_api_key_actor
108113
109114 - `spend_summary: SpendSummary or null`
110115
111116 Per-member effective-limit report row (GET /spend_limits/effective).
112117
113 - `actor: object { deleted, email_address, name, 2 more }`
118 - `actor: object`
114119
115120 A user within the organization. `name` and `email_address` are
116121 null when the underlying account is unavailable or has been deleted;
from line 123
118123
119124 - `deleted: boolean`
120125
126 default: false
127
121128 - `email_address: string or null`
122129
123130 - `name: string or null`
124131
125132 - `type: "user_actor"`
126133
127 - `"user_actor"`
134 default: user_actor
128135
129136 - `user_id: string`
130137
from line 155
148155
149156 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
150157
151 - `scope: object { type, user_id }`
158 - `scope: object`
152159
153160 - `type: "user"`
154161
155 - `"user"`
162 default: user
156163
157164 - `user_id: string`
158165
159 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
160
161 - `User object { type, user_id }`
166 - `source: object or object or object or 2 more`
167
168 - `User object`
162169
163170 - `type: "user"`
164171
165 - `"user"`
172 default: user
166173
167174 - `user_id: string`
168175
169 - `SeatTier object { seat_tier, type }`
176 - `SeatTier object`
170177
171178 - `seat_tier: string`
172179
173180 - `type: "seat_tier"`
174181
175 - `"seat_tier"`
176
177 - `RbacGroup object { rbac_group_id, type }`
182 default: seat_tier
183
184 - `RbacGroup object`
178185
179186 - `rbac_group_id: string`
180187
181188 - `type: "rbac_group"`
182189
183 - `"rbac_group"`
184
185 - `OrganizationService object { service, type }`
190 default: rbac_group
191
192 - `OrganizationService object`
186193
187194 - `service: string`
188195
189196 - `type: "organization_service"`
190197
191 - `"organization_service"`
192
193 - `Organization object { type }`
198 default: organization_service
199
200 - `Organization object`
194201
195202 - `type: "organization"`
196203
197 - `"organization"`
204 default: organization
198205
199206 - `spend_limit_id: string`
200207
from line 215
208215
209216 - `type: "spend_limit_increase_request"`
210217
211 - `"spend_limit_increase_request"`
218 default: spend_limit_increase_request
212219
213220- `next_page: string or null`
214221
215222### Example
216223
217```http
224```bash
218225curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \
219226 -H 'anthropic-version: 2023-06-01' \
220227 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
221228```
222229
223#### Response
230#### Response (200)
224231
225232```json
226233{
from line 283
276283
277284## Get Spend Limit Increase Request
278285
279**get** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}`
286**GET** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}`
280287
281288Retrieve a spend limit increase request.
282289
283290While `pending`, the response includes a live `spend_summary` for the
284291requester at the request's period.
285292
286### Path Parameters
293### Path parameters
287294
288295- `spend_limit_increase_request_id: string`
289296
from line 298
291298
292299### Returns
293300
294- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`
301- `SpendLimitIncreaseRequest object`
295302
296303 - `id: string`
297304
298 - `actor: object { deleted, email_address, name, 2 more }`
305 - `actor: object`
299306
300307 A user within the organization. `name` and `email_address` are
301308 null when the underlying account is unavailable or has been deleted;
from line 310
303310
304311 - `deleted: boolean`
305312
313 default: false
314
306315 - `email_address: string or null`
307316
308317 - `name: string or null`
309318
310319 - `type: "user_actor"`
311320
312 - `"user_actor"`
321 default: user_actor
313322
314323 - `user_id: string`
315324
316325 - `created_at: string`
317326
327 format: date-time
328
318329 - `period: "daily" or "monthly" or "weekly"`
319330
320331 - `"daily"`
from line 336
325336
326337 - `resolved_at: string or null`
327338
328 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
339 format: date-time
340
341 - `resolved_by: object or object or null`
329342
330343 A user within the organization. `name` and `email_address` are
331344 null when the underlying account is unavailable or has been deleted;
332345 `deleted` is true only for deleted accounts.
333346
334 - `UserActor object { deleted, email_address, name, 2 more }`
347 - `UserActor object`
335348
336349 A user within the organization. `name` and `email_address` are
337350 null when the underlying account is unavailable or has been deleted;
from line 352
339352
340353 - `deleted: boolean`
341354
355 default: false
356
342357 - `email_address: string or null`
343358
344359 - `name: string or null`
345360
346361 - `type: "user_actor"`
347362
348 - `"user_actor"`
363 default: user_actor
349364
350365 - `user_id: string`
351366
352 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
367 - `ScopedAPIKeyActor object`
353368
354369 A scoped Admin API key acting on behalf of the organization.
355370
from line 372
357372
358373 - `type: "scoped_api_key_actor"`
359374
360 - `"scoped_api_key_actor"`
375 default: scoped_api_key_actor
361376
362377 - `spend_summary: SpendSummary or null`
363378
364379 Per-member effective-limit report row (GET /spend_limits/effective).
365380
366 - `actor: object { deleted, email_address, name, 2 more }`
381 - `actor: object`
367382
368383 A user within the organization. `name` and `email_address` are
369384 null when the underlying account is unavailable or has been deleted;
from line 386
371386
372387 - `deleted: boolean`
373388
389 default: false
390
374391 - `email_address: string or null`
375392
376393 - `name: string or null`
377394
378395 - `type: "user_actor"`
379396
380 - `"user_actor"`
397 default: user_actor
381398
382399 - `user_id: string`
383400
from line 418
401418
402419 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
403420
404 - `scope: object { type, user_id }`
421 - `scope: object`
405422
406423 - `type: "user"`
407424
408 - `"user"`
425 default: user
409426
410427 - `user_id: string`
411428
412 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
413
414 - `User object { type, user_id }`
429 - `source: object or object or object or 2 more`
430
431 - `User object`
415432
416433 - `type: "user"`
417434
418 - `"user"`
435 default: user
419436
420437 - `user_id: string`
421438
422 - `SeatTier object { seat_tier, type }`
439 - `SeatTier object`
423440
424441 - `seat_tier: string`
425442
426443 - `type: "seat_tier"`
427444
428 - `"seat_tier"`
429
430 - `RbacGroup object { rbac_group_id, type }`
445 default: seat_tier
446
447 - `RbacGroup object`
431448
432449 - `rbac_group_id: string`
433450
434451 - `type: "rbac_group"`
435452
436 - `"rbac_group"`
437
438 - `OrganizationService object { service, type }`
453 default: rbac_group
454
455 - `OrganizationService object`
439456
440457 - `service: string`
441458
442459 - `type: "organization_service"`
443460
444 - `"organization_service"`
445
446 - `Organization object { type }`
461 default: organization_service
462
463 - `Organization object`
447464
448465 - `type: "organization"`
449466
450 - `"organization"`
467 default: organization
451468
452469 - `spend_limit_id: string`
453470
from line 478
461478
462479 - `type: "spend_limit_increase_request"`
463480
464 - `"spend_limit_increase_request"`
481 default: spend_limit_increase_request
465482
466483### Example
467484
468```http
485```bash
469486curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
470487 -H 'anthropic-version: 2023-06-01' \
471488 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
472489```
473490
474#### Response
491#### Response (200)
475492
476493```json
477494{
from line 539
522539
523540## Approve Spend Limit Increase Request
524541
525**post** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve`
542**POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve`
526543
527544Approve a pending spend limit increase request.
528545
from line 548
531548the member was blocked on. Anthropic emails the requester unless
532549`suppress_notification` is set.
533550
534### Path Parameters
551### Path parameters
535552
536553- `spend_limit_increase_request_id: string`
537554
538555 ID of the spend limit increase request.
539556
540### Body Parameters
557### Body parameters
541558
542559- `amount: string`
543560
from line 574
557574
558575- `id: string`
559576
560- `actor: object { deleted, email_address, name, 2 more }`
577- `actor: object`
561578
562579 A user within the organization. `name` and `email_address` are
563580 null when the underlying account is unavailable or has been deleted;
from line 582
565582
566583 - `deleted: boolean`
567584
585 default: false
586
568587 - `email_address: string or null`
569588
570589 - `name: string or null`
571590
572591 - `type: "user_actor"`
573592
574 - `"user_actor"`
593 default: user_actor
575594
576595 - `user_id: string`
577596
578597- `created_at: string`
579598
599 format: date-time
600
580601- `period: "daily" or "monthly" or "weekly"`
581602
582603 - `"daily"`
from line 608
587608
588609- `resolved_at: string or null`
589610
590- `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
611 format: date-time
612
613- `resolved_by: object or object or null`
591614
592615 A user within the organization. `name` and `email_address` are
593616 null when the underlying account is unavailable or has been deleted;
594617 `deleted` is true only for deleted accounts.
595618
596 - `UserActor object { deleted, email_address, name, 2 more }`
619 - `UserActor object`
597620
598621 A user within the organization. `name` and `email_address` are
599622 null when the underlying account is unavailable or has been deleted;
from line 624
601624
602625 - `deleted: boolean`
603626
627 default: false
628
604629 - `email_address: string or null`
605630
606631 - `name: string or null`
607632
608633 - `type: "user_actor"`
609634
610 - `"user_actor"`
635 default: user_actor
611636
612637 - `user_id: string`
613638
614 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
639 - `ScopedAPIKeyActor object`
615640
616641 A scoped Admin API key acting on behalf of the organization.
617642
from line 644
619644
620645 - `type: "scoped_api_key_actor"`
621646
622 - `"scoped_api_key_actor"`
647 default: scoped_api_key_actor
623648
624649- `spend_limit: SpendLimit`
625650
from line 656
631656
632657 - `created_at: string`
633658
659 format: date-time
660
634661 - `currency: string`
635662
636663 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 670
643670
644671 - `"weekly"`
645672
646 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
647
648 - `User object { type, user_id }`
673 - `scope: object or object or object or 2 more`
674
675 - `User object`
649676
650677 - `type: "user"`
651678
652 - `"user"`
679 default: user
653680
654681 - `user_id: string`
655682
656 - `SeatTier object { seat_tier, type }`
683 - `SeatTier object`
657684
658685 - `seat_tier: string`
659686
660687 - `type: "seat_tier"`
661688
662 - `"seat_tier"`
663
664 - `RbacGroup object { rbac_group_id, type }`
689 default: seat_tier
690
691 - `RbacGroup object`
665692
666693 - `rbac_group_id: string`
667694
668695 - `type: "rbac_group"`
669696
670 - `"rbac_group"`
671
672 - `OrganizationService object { service, type }`
697 default: rbac_group
698
699 - `OrganizationService object`
673700
674701 - `service: string`
675702
676703 - `type: "organization_service"`
677704
678 - `"organization_service"`
679
680 - `Organization object { type }`
705 default: organization_service
706
707 - `Organization object`
681708
682709 - `type: "organization"`
683710
684 - `"organization"`
711 default: organization
685712
686713 - `type: "spend_limit"`
687714
688 - `"spend_limit"`
715 default: spend_limit
689716
690717 - `updated_at: string`
691718
719 format: date-time
720
692721- `spend_summary: SpendSummary or null`
693722
694723 Per-member effective-limit report row (GET /spend_limits/effective).
695724
696 - `actor: object { deleted, email_address, name, 2 more }`
725 - `actor: object`
697726
698727 A user within the organization. `name` and `email_address` are
699728 null when the underlying account is unavailable or has been deleted;
from line 730
701730
702731 - `deleted: boolean`
703732
733 default: false
734
704735 - `email_address: string or null`
705736
706737 - `name: string or null`
707738
708739 - `type: "user_actor"`
709740
710 - `"user_actor"`
741 default: user_actor
711742
712743 - `user_id: string`
713744
from line 762
731762
732763 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
733764
734 - `scope: object { type, user_id }`
765 - `scope: object`
735766
736767 - `type: "user"`
737768
738 - `"user"`
769 default: user
739770
740771 - `user_id: string`
741772
742 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
743
744 - `User object { type, user_id }`
773 - `source: object or object or object or 2 more`
774
775 - `User object`
745776
746777 - `type: "user"`
747778
748 - `"user"`
779 default: user
749780
750781 - `user_id: string`
751782
752 - `SeatTier object { seat_tier, type }`
783 - `SeatTier object`
753784
754785 - `seat_tier: string`
755786
756787 - `type: "seat_tier"`
757788
758 - `"seat_tier"`
759
760 - `RbacGroup object { rbac_group_id, type }`
789 default: seat_tier
790
791 - `RbacGroup object`
761792
762793 - `rbac_group_id: string`
763794
764795 - `type: "rbac_group"`
765796
766 - `"rbac_group"`
767
768 - `OrganizationService object { service, type }`
797 default: rbac_group
798
799 - `OrganizationService object`
769800
770801 - `service: string`
771802
772803 - `type: "organization_service"`
773804
774 - `"organization_service"`
775
776 - `Organization object { type }`
805 default: organization_service
806
807 - `Organization object`
777808
778809 - `type: "organization"`
779810
780 - `"organization"`
811 default: organization
781812
782813 - `spend_limit_id: string`
783814
from line 822
791822
792823- `type: "spend_limit_increase_request"`
793824
794 - `"spend_limit_increase_request"`
825 default: spend_limit_increase_request
795826
796827### Example
797828
798```http
829```bash
799830curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
800831 -H 'Content-Type: application/json' \
801832 -H 'anthropic-version: 2023-06-01' \
from line 837
806837 }'
807838```
808839
809#### Response
840#### Response (200)
810841
811842```json
812843{
from line 901
870901
871902## Deny Spend Limit Increase Request
872903
873**post** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny`
904**POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny`
874905
875906Deny a pending spend limit increase request.
876907
877908Idempotent on `denied`; denying an already-`approved` request returns
878909400. Anthropic emails the requester unless `suppress_notification` is set.
879910
880### Path Parameters
911### Path parameters
881912
882913- `spend_limit_increase_request_id: string`
883914
884915 ID of the spend limit increase request.
885916
886### Body Parameters
917### Body parameters
887918
888919- `suppress_notification: optional boolean`
889920
890921### Returns
891922
892- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`
923- `SpendLimitIncreaseRequest object`
893924
894925 - `id: string`
895926
896 - `actor: object { deleted, email_address, name, 2 more }`
927 - `actor: object`
897928
898929 A user within the organization. `name` and `email_address` are
899930 null when the underlying account is unavailable or has been deleted;
from line 932
901932
902933 - `deleted: boolean`
903934
935 default: false
936
904937 - `email_address: string or null`
905938
906939 - `name: string or null`
907940
908941 - `type: "user_actor"`
909942
910 - `"user_actor"`
943 default: user_actor
911944
912945 - `user_id: string`
913946
914947 - `created_at: string`
915948
949 format: date-time
950
916951 - `period: "daily" or "monthly" or "weekly"`
917952
918953 - `"daily"`
from line 958
923958
924959 - `resolved_at: string or null`
925960
926 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
961 format: date-time
962
963 - `resolved_by: object or object or null`
927964
928965 A user within the organization. `name` and `email_address` are
929966 null when the underlying account is unavailable or has been deleted;
930967 `deleted` is true only for deleted accounts.
931968
932 - `UserActor object { deleted, email_address, name, 2 more }`
969 - `UserActor object`
933970
934971 A user within the organization. `name` and `email_address` are
935972 null when the underlying account is unavailable or has been deleted;
from line 974
937974
938975 - `deleted: boolean`
939976
977 default: false
978
940979 - `email_address: string or null`
941980
942981 - `name: string or null`
943982
944983 - `type: "user_actor"`
945984
946 - `"user_actor"`
985 default: user_actor
947986
948987 - `user_id: string`
949988
950 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
989 - `ScopedAPIKeyActor object`
951990
952991 A scoped Admin API key acting on behalf of the organization.
953992
from line 994
955994
956995 - `type: "scoped_api_key_actor"`
957996
958 - `"scoped_api_key_actor"`
997 default: scoped_api_key_actor
959998
960999 - `spend_summary: SpendSummary or null`
9611000
9621001 Per-member effective-limit report row (GET /spend_limits/effective).
9631002
964 - `actor: object { deleted, email_address, name, 2 more }`
1003 - `actor: object`
9651004
9661005 A user within the organization. `name` and `email_address` are
9671006 null when the underlying account is unavailable or has been deleted;
from line 1008
9691008
9701009 - `deleted: boolean`
9711010
1011 default: false
1012
9721013 - `email_address: string or null`
9731014
9741015 - `name: string or null`
9751016
9761017 - `type: "user_actor"`
9771018
978 - `"user_actor"`
1019 default: user_actor
9791020
9801021 - `user_id: string`
9811022
from line 1040
9991040
10001041 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
10011042
1002 - `scope: object { type, user_id }`
1043 - `scope: object`
10031044
10041045 - `type: "user"`
10051046
1006 - `"user"`
1047 default: user
10071048
10081049 - `user_id: string`
10091050
1010 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1011
1012 - `User object { type, user_id }`
1051 - `source: object or object or object or 2 more`
1052
1053 - `User object`
10131054
10141055 - `type: "user"`
10151056
1016 - `"user"`
1057 default: user
10171058
10181059 - `user_id: string`
10191060
1020 - `SeatTier object { seat_tier, type }`
1061 - `SeatTier object`
10211062
10221063 - `seat_tier: string`
10231064
10241065 - `type: "seat_tier"`
10251066
1026 - `"seat_tier"`
1027
1028 - `RbacGroup object { rbac_group_id, type }`
1067 default: seat_tier
1068
1069 - `RbacGroup object`
10291070
10301071 - `rbac_group_id: string`
10311072
10321073 - `type: "rbac_group"`
10331074
1034 - `"rbac_group"`
1035
1036 - `OrganizationService object { service, type }`
1075 default: rbac_group
1076
1077 - `OrganizationService object`
10371078
10381079 - `service: string`
10391080
10401081 - `type: "organization_service"`
10411082
1042 - `"organization_service"`
1043
1044 - `Organization object { type }`
1083 default: organization_service
1084
1085 - `Organization object`
10451086
10461087 - `type: "organization"`
10471088
1048 - `"organization"`
1089 default: organization
10491090
10501091 - `spend_limit_id: string`
10511092
from line 1100
10591100
10601101 - `type: "spend_limit_increase_request"`
10611102
1062 - `"spend_limit_increase_request"`
1103 default: spend_limit_increase_request
10631104
10641105### Example
10651106
1066```http
1107```bash
10671108curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
10681109 -H 'Content-Type: application/json' \
10691110 -H 'anthropic-version: 2023-06-01' \
from line 1112
10711112 -d '{}'
10721113```
10731114
1074#### Response
1115#### Response (200)
10751116
10761117```json
10771118{
from line 1161
11201161}
11211162```
11221163
1123## Domain Types
1164## Domain types
11241165
11251166### Spend Limit Increase Request
11261167
1127- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`
1168- `SpendLimitIncreaseRequest object`
11281169
11291170 - `id: string`
11301171
1131 - `actor: object { deleted, email_address, name, 2 more }`
1172 - `actor: object`
11321173
11331174 A user within the organization. `name` and `email_address` are
11341175 null when the underlying account is unavailable or has been deleted;
from line 1177
11361177
11371178 - `deleted: boolean`
11381179
1180 default: false
1181
11391182 - `email_address: string or null`
11401183
11411184 - `name: string or null`
11421185
11431186 - `type: "user_actor"`
11441187
1145 - `"user_actor"`
1188 default: user_actor
11461189
11471190 - `user_id: string`
11481191
11491192 - `created_at: string`
11501193
1194 format: date-time
1195
11511196 - `period: "daily" or "monthly" or "weekly"`
11521197
11531198 - `"daily"`
from line 1203
11581203
11591204 - `resolved_at: string or null`
11601205
1161 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
1206 format: date-time
1207
1208 - `resolved_by: object or object or null`
11621209
11631210 A user within the organization. `name` and `email_address` are
11641211 null when the underlying account is unavailable or has been deleted;
11651212 `deleted` is true only for deleted accounts.
11661213
1167 - `UserActor object { deleted, email_address, name, 2 more }`
1214 - `UserActor object`
11681215
11691216 A user within the organization. `name` and `email_address` are
11701217 null when the underlying account is unavailable or has been deleted;
from line 1219
11721219
11731220 - `deleted: boolean`
11741221
1222 default: false
1223
11751224 - `email_address: string or null`
11761225
11771226 - `name: string or null`
11781227
11791228 - `type: "user_actor"`
11801229
1181 - `"user_actor"`
1230 default: user_actor
11821231
11831232 - `user_id: string`
11841233
1185 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1234 - `ScopedAPIKeyActor object`
11861235
11871236 A scoped Admin API key acting on behalf of the organization.
11881237
from line 1239
11901239
11911240 - `type: "scoped_api_key_actor"`
11921241
1193 - `"scoped_api_key_actor"`
1242 default: scoped_api_key_actor
11941243
11951244 - `spend_summary: SpendSummary or null`
11961245
11971246 Per-member effective-limit report row (GET /spend_limits/effective).
11981247
1199 - `actor: object { deleted, email_address, name, 2 more }`
1248 - `actor: object`
12001249
12011250 A user within the organization. `name` and `email_address` are
12021251 null when the underlying account is unavailable or has been deleted;
from line 1253
12041253
12051254 - `deleted: boolean`
12061255
1256 default: false
1257
12071258 - `email_address: string or null`
12081259
12091260 - `name: string or null`
12101261
12111262 - `type: "user_actor"`
12121263
1213 - `"user_actor"`
1264 default: user_actor
12141265
12151266 - `user_id: string`
12161267
from line 1285
12341285
12351286 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
12361287
1237 - `scope: object { type, user_id }`
1288 - `scope: object`
12381289
12391290 - `type: "user"`
12401291
1241 - `"user"`
1292 default: user
12421293
12431294 - `user_id: string`
12441295
1245 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1246
1247 - `User object { type, user_id }`
1296 - `source: object or object or object or 2 more`
1297
1298 - `User object`
12481299
12491300 - `type: "user"`
12501301
1251 - `"user"`
1302 default: user
12521303
12531304 - `user_id: string`
12541305
1255 - `SeatTier object { seat_tier, type }`
1306 - `SeatTier object`
12561307
12571308 - `seat_tier: string`
12581309
12591310 - `type: "seat_tier"`
12601311
1261 - `"seat_tier"`
1262
1263 - `RbacGroup object { rbac_group_id, type }`
1312 default: seat_tier
1313
1314 - `RbacGroup object`
12641315
12651316 - `rbac_group_id: string`
12661317
12671318 - `type: "rbac_group"`
12681319
1269 - `"rbac_group"`
1270
1271 - `OrganizationService object { service, type }`
1320 default: rbac_group
1321
1322 - `OrganizationService object`
12721323
12731324 - `service: string`
12741325
12751326 - `type: "organization_service"`
12761327
1277 - `"organization_service"`
1278
1279 - `Organization object { type }`
1328 default: organization_service
1329
1330 - `Organization object`
12801331
12811332 - `type: "organization"`
12821333
1283 - `"organization"`
1334 default: organization
12841335
12851336 - `spend_limit_id: string`
12861337
from line 1345
12941345
12951346 - `type: "spend_limit_increase_request"`
12961347
1297 - `"spend_limit_increase_request"`
1348 default: spend_limit_increase_request
12981349
12991350### Increase Request Approve Response
13001351
1301- `IncreaseRequestApproveResponse object { id, actor, created_at, 7 more }`
1352- `IncreaseRequestApproveResponse object`
13021353
13031354 - `id: string`
13041355
1305 - `actor: object { deleted, email_address, name, 2 more }`
1356 - `actor: object`
13061357
13071358 A user within the organization. `name` and `email_address` are
13081359 null when the underlying account is unavailable or has been deleted;
from line 1361
13101361
13111362 - `deleted: boolean`
13121363
1364 default: false
1365
13131366 - `email_address: string or null`
13141367
13151368 - `name: string or null`
13161369
13171370 - `type: "user_actor"`
13181371
1319 - `"user_actor"`
1372 default: user_actor
13201373
13211374 - `user_id: string`
13221375
13231376 - `created_at: string`
13241377
1378 format: date-time
1379
13251380 - `period: "daily" or "monthly" or "weekly"`
13261381
13271382 - `"daily"`
from line 1387
13321387
13331388 - `resolved_at: string or null`
13341389
1335 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
1390 format: date-time
1391
1392 - `resolved_by: object or object or null`
13361393
13371394 A user within the organization. `name` and `email_address` are
13381395 null when the underlying account is unavailable or has been deleted;
13391396 `deleted` is true only for deleted accounts.
13401397
1341 - `UserActor object { deleted, email_address, name, 2 more }`
1398 - `UserActor object`
13421399
13431400 A user within the organization. `name` and `email_address` are
13441401 null when the underlying account is unavailable or has been deleted;
from line 1403
13461403
13471404 - `deleted: boolean`
13481405
1406 default: false
1407
13491408 - `email_address: string or null`
13501409
13511410 - `name: string or null`
13521411
13531412 - `type: "user_actor"`
13541413
1355 - `"user_actor"`
1414 default: user_actor
13561415
13571416 - `user_id: string`
13581417
1359 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
1418 - `ScopedAPIKeyActor object`
13601419
13611420 A scoped Admin API key acting on behalf of the organization.
13621421
from line 1423
13641423
13651424 - `type: "scoped_api_key_actor"`
13661425
1367 - `"scoped_api_key_actor"`
1426 default: scoped_api_key_actor
13681427
13691428 - `spend_limit: SpendLimit`
13701429
from line 1435
13761435
13771436 - `created_at: string`
13781437
1438 format: date-time
1439
13791440 - `currency: string`
13801441
13811442 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 1449
13881449
13891450 - `"weekly"`
13901451
1391 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1392
1393 - `User object { type, user_id }`
1452 - `scope: object or object or object or 2 more`
1453
1454 - `User object`
13941455
13951456 - `type: "user"`
13961457
1397 - `"user"`
1458 default: user
13981459
13991460 - `user_id: string`
14001461
1401 - `SeatTier object { seat_tier, type }`
1462 - `SeatTier object`
14021463
14031464 - `seat_tier: string`
14041465
14051466 - `type: "seat_tier"`
14061467
1407 - `"seat_tier"`
1408
1409 - `RbacGroup object { rbac_group_id, type }`
1468 default: seat_tier
1469
1470 - `RbacGroup object`
14101471
14111472 - `rbac_group_id: string`
14121473
14131474 - `type: "rbac_group"`
14141475
1415 - `"rbac_group"`
1416
1417 - `OrganizationService object { service, type }`
1476 default: rbac_group
1477
1478 - `OrganizationService object`
14181479
14191480 - `service: string`
14201481
14211482 - `type: "organization_service"`
14221483
1423 - `"organization_service"`
1424
1425 - `Organization object { type }`
1484 default: organization_service
1485
1486 - `Organization object`
14261487
14271488 - `type: "organization"`
14281489
1429 - `"organization"`
1490 default: organization
14301491
14311492 - `type: "spend_limit"`
14321493
1433 - `"spend_limit"`
1494 default: spend_limit
14341495
14351496 - `updated_at: string`
14361497
1498 format: date-time
1499
14371500 - `spend_summary: SpendSummary or null`
14381501
14391502 Per-member effective-limit report row (GET /spend_limits/effective).
14401503
1441 - `actor: object { deleted, email_address, name, 2 more }`
1504 - `actor: object`
14421505
14431506 A user within the organization. `name` and `email_address` are
14441507 null when the underlying account is unavailable or has been deleted;
from line 1509
14461509
14471510 - `deleted: boolean`
14481511
1512 default: false
1513
14491514 - `email_address: string or null`
14501515
14511516 - `name: string or null`
14521517
14531518 - `type: "user_actor"`
14541519
1455 - `"user_actor"`
1520 default: user_actor
14561521
14571522 - `user_id: string`
14581523
from line 1541
14761541
14771542 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
14781543
1479 - `scope: object { type, user_id }`
1544 - `scope: object`
14801545
14811546 - `type: "user"`
14821547
1483 - `"user"`
1548 default: user
14841549
14851550 - `user_id: string`
14861551
1487 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
1488
1489 - `User object { type, user_id }`
1552 - `source: object or object or object or 2 more`
1553
1554 - `User object`
14901555
14911556 - `type: "user"`
14921557
1493 - `"user"`
1558 default: user
14941559
14951560 - `user_id: string`
14961561
1497 - `SeatTier object { seat_tier, type }`
1562 - `SeatTier object`
14981563
14991564 - `seat_tier: string`
15001565
15011566 - `type: "seat_tier"`
15021567
1503 - `"seat_tier"`
1504
1505 - `RbacGroup object { rbac_group_id, type }`
1568 default: seat_tier
1569
1570 - `RbacGroup object`
15061571
15071572 - `rbac_group_id: string`
15081573
15091574 - `type: "rbac_group"`
15101575
1511 - `"rbac_group"`
1512
1513 - `OrganizationService object { service, type }`
1576 default: rbac_group
1577
1578 - `OrganizationService object`
15141579
15151580 - `service: string`
15161581
15171582 - `type: "organization_service"`
15181583
1519 - `"organization_service"`
1520
1521 - `Organization object { type }`
1584 default: organization_service
1585
1586 - `Organization object`
15221587
15231588 - `type: "organization"`
15241589
1525 - `"organization"`
1590 default: organization
15261591
15271592 - `spend_limit_id: string`
15281593
from line 1601
15361601
15371602 - `type: "spend_limit_increase_request"`
15381603
1539 - `"spend_limit_increase_request"`
1604 default: spend_limit_increase_request
15401605
api/admin/spend_limits/increase_requests/approve Changed · +68 / -59 lines
# Approve Spend Limit Increase Request ## Path parameters ## Body parameters ## Returns ## Example ### Response (200) ## Approve Spend Limit Increase Request ### Path Parameters ### Body Parameters ### Returns ### Example #### Response
from line 1
1---
2title: Approve Spend Limit Increase Request
3url: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/approve
4---
1# Approve Spend Limit Increase Request
52
6## Approve Spend Limit Increase Request
3**POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve`
74
8**post** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve`
9
105Approve a pending spend limit increase request.
116
127Writes a per-user spend limit at `amount` for the requester and
from line 9
149the member was blocked on. Anthropic emails the requester unless
1510`suppress_notification` is set.
1611
17### Path Parameters
12## Path parameters
1813
1914- `spend_limit_increase_request_id: string`
2015
2116 ID of the spend limit increase request.
2217
23### Body Parameters
18## Body parameters
2419
2520- `amount: string`
2621
from line 31
3631
3732- `suppress_notification: optional boolean`
3833
39### Returns
34## Returns
4035
4136- `id: string`
4237
43- `actor: object { deleted, email_address, name, 2 more }`
38- `actor: object`
4439
4540 A user within the organization. `name` and `email_address` are
4641 null when the underlying account is unavailable or has been deleted;
from line 43
4843
4944 - `deleted: boolean`
5045
46 default: false
47
5148 - `email_address: string or null`
5249
5350 - `name: string or null`
from line 51
5451
5552 - `type: "user_actor"`
5653
57 - `"user_actor"`
54 default: user_actor
5855
5956 - `user_id: string`
6057
6158- `created_at: string`
6259
60 format: date-time
61
6362- `period: "daily" or "monthly" or "weekly"`
6463
6564 - `"daily"`
from line 69
7069
7170- `resolved_at: string or null`
7271
73- `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`
72 format: date-time
7473
74- `resolved_by: object or object or null`
75
7576 A user within the organization. `name` and `email_address` are
7677 null when the underlying account is unavailable or has been deleted;
7778 `deleted` is true only for deleted accounts.
7879
79 - `UserActor object { deleted, email_address, name, 2 more }`
80 - `UserActor object`
8081
8182 A user within the organization. `name` and `email_address` are
8283 null when the underlying account is unavailable or has been deleted;
from line 85
8485
8586 - `deleted: boolean`
8687
88 default: false
89
8790 - `email_address: string or null`
8891
8992 - `name: string or null`
from line 93
9093
9194 - `type: "user_actor"`
9295
93 - `"user_actor"`
96 default: user_actor
9497
9598 - `user_id: string`
9699
97 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`
100 - `ScopedAPIKeyActor object`
98101
99102 A scoped Admin API key acting on behalf of the organization.
100103
from line 105
102105
103106 - `type: "scoped_api_key_actor"`
104107
105 - `"scoped_api_key_actor"`
108 default: scoped_api_key_actor
106109
107110- `spend_limit: SpendLimit`
108111
from line 117
114117
115118 - `created_at: string`
116119
120 format: date-time
121
117122 - `currency: string`
118123
119124 ISO 4217 code of the organization's billing currency; the unit for `amount`.
from line 131
126131
127132 - `"weekly"`
128133
129 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
134 - `scope: object or object or object or 2 more`
130135
131 - `User object { type, user_id }`
136 - `User object`
132137
133138 - `type: "user"`
134139
135 - `"user"`
140 default: user
136141
137142 - `user_id: string`
138143
139 - `SeatTier object { seat_tier, type }`
144 - `SeatTier object`
140145
141146 - `seat_tier: string`
142147
143148 - `type: "seat_tier"`
144149
145 - `"seat_tier"`
150 default: seat_tier
146151
147 - `RbacGroup object { rbac_group_id, type }`
152 - `RbacGroup object`
148153
149154 - `rbac_group_id: string`
150155
151156 - `type: "rbac_group"`
152157
153 - `"rbac_group"`
158 default: rbac_group
154159
155 - `OrganizationService object { service, type }`
160 - `OrganizationService object`
156161
157162 - `service: string`
158163
159164 - `type: "organization_service"`
160165
161 - `"organization_service"`
166 default: organization_service
162167
163 - `Organization object { type }`
168 - `Organization object`
164169
165170 - `type: "organization"`
166171
167 - `"organization"`
172 default: organization
168173
169174 - `type: "spend_limit"`
170175
171 - `"spend_limit"`
176 default: spend_limit
172177
173178 - `updated_at: string`
174179
180 format: date-time
181
175182- `spend_summary: SpendSummary or null`
176183
177184 Per-member effective-limit report row (GET /spend_limits/effective).
178185
179 - `actor: object { deleted, email_address, name, 2 more }`
186 - `actor: object`
180187
181188 A user within the organization. `name` and `email_address` are
182189 null when the underlying account is unavailable or has been deleted;
from line 191
184191
185192 - `deleted: boolean`
186193
194 default: false
195
187196 - `email_address: string or null`
188197
189198 - `name: string or null`
from line 199
190199
191200 - `type: "user_actor"`
192201
193 - `"user_actor"`
202 default: user_actor
194203
195204 - `user_id: string`
196205
from line 223
214223
215224 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
216225
217 - `scope: object { type, user_id }`
226 - `scope: object`
218227
219228 - `type: "user"`
220229
221 - `"user"`
230 default: user
222231
223232 - `user_id: string`
224233
225 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`
234 - `source: object or object or object or 2 more`
226235
227 - `User object { type, user_id }`
236 - `User object`
228237
229238 - `type: "user"`
230239
231 - `"user"`
240 default: user
232241
233242 - `user_id: string`
234243
235 - `SeatTier object { seat_tier, type }`
244 - `SeatTier object`
236245
237246 - `seat_tier: string`
238247
239248 - `type: "seat_tier"`
240249
241 - `"seat_tier"`
250 default: seat_tier
242251
243 - `RbacGroup object { rbac_group_id, type }`
252 - `RbacGroup object`
244253
245254 - `rbac_group_id: string`
246255
247256 - `type: "rbac_group"`
248257
249 - `"rbac_group"`
258 default: rbac_group
250259
251 - `OrganizationService object { service, type }`
260 - `OrganizationService object`
252261
253262 - `service: string`
254263
255264 - `type: "organization_service"`
256265
257 - `"organization_service"`
266 default: organization_service
258267
259 - `Organization object { type }`
268 - `Organization object`
260269
261270 - `type: "organization"`
262271
263 - `"organization"`
272 default: organization
264273
265274 - `spend_limit_id: string`
266275
from line 283
274283
275284- `type: "spend_limit_increase_request"`
276285
277 - `"spend_limit_increase_request"`
286 default: spend_limit_increase_request
278287
279### Example
288## Example
280289
281```http
290```bash
282291curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
283292 -H 'Content-Type: application/json' \
284293 -H 'anthropic-version: 2023-06-01' \
from line 298
289298 }'
290299```
291300
292#### Response
301### Response (200)
293302
294303```json
295304{