One read of Claude Developer Platformapi-20261009T153709Z
536 pages moved out of 760 read.
Pages moved
536
significant first
Pages read
760
in this capture
Captured
15:37 UTC
Corpus hash
9680386eb15e
corpus-hash
What this read moved
301-325 of 536, page 13 of 22This capture is too large to show at once. Changes 301-325 of 536 are below, significant first; the rest are on the following screens.
api/organization Changed · +464 / -0 lines
### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers
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 10
1010**GET** `/v1/organizations/me`
1111
1212Retrieve information about the organization associated with the authenticated API key.
13
14### Headers
15
16- `"anthropic-version": optional string`
17
18 The version of the Claude API you want to use.
19
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1321
1422### Returns
1523
from line 150
142150- `workspace_id: optional string`
143151
144152 Filter by Workspace ID.
153
154#### Headers
155
156- `"anthropic-version": optional string`
157
158 The version of the Claude API you want to use.
159
160 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
145161
146162#### Returns
147163
from line 349
333349
334350 ID of the API key.
335351
352#### Headers
353
354- `"anthropic-version": optional string`
355
356 The version of the Claude API you want to use.
357
358 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
359
336360#### Returns
337361
338362- `APIKey object`
from line 528
504528
505529 ID of the API key.
506530
531#### Headers
532
533- `"anthropic-version": optional string`
534
535 The version of the Claude API you want to use.
536
537 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
538
507539#### Body parameters
508540
509541- `name: optional string or null`
from line 723
691723
692724Create an external key config owned by the caller's organization.
693725
726#### Headers
727
728- `"anthropic-version": optional string`
729
730 The version of the Claude API you want to use.
731
732 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
733
694734#### Body parameters
695735
696736- `provider_config: AWSExternalKeyConfig or GCPExternalKeyConfig or AzureExternalKeyConfigParam`
from line 956
916956- `page: optional string`
917957
918958 Opaque cursor from a previous response's `next_page`.
959
960#### Headers
961
962- `"anthropic-version": optional string`
963
964 The version of the Claude API you want to use.
965
966 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
919967
920968#### Returns
921969
from line 1114
10661114
10671115 maxLength: 2048
10681116
1117#### Headers
1118
1119- `"anthropic-version": optional string`
1120
1121 The version of the Claude API you want to use.
1122
1123 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1124
10691125#### Returns
10701126
10711127- `ExternalKey object`
from line 1272
12161272
12171273 maxLength: 2048
12181274
1275#### Headers
1276
1277- `"anthropic-version": optional string`
1278
1279 The version of the Claude API you want to use.
1280
1281 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1282
12191283#### Body parameters
12201284
12211285- `display_name: optional string or null`
from line 1496
14321496
14331497 maxLength: 2048
14341498
1499#### Headers
1500
1501- `"anthropic-version": optional string`
1502
1503 The version of the Claude API you want to use.
1504
1505 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1506
14351507#### Returns
14361508
14371509- `type: "external_key_deleted"`
from line 1550
14781550 ID of the External Key.
14791551
14801552 maxLength: 2048
1553
1554#### Headers
1555
1556- `"anthropic-version": optional string`
1557
1558 The version of the Claude API you want to use.
1559
1560 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
14811561
14821562#### Returns
14831563
from line 1615
15351615publicly reachable over HTTPS so Anthropic can fetch the discovery
15361616document; for `explicit_url` and `inline` modes the issuer URL is only
15371617matched as the JWT's `iss` claim and is not fetched.
1618
1619#### Headers
1620
1621- `"anthropic-version": optional string`
1622
1623 The version of the Claude API you want to use.
1624
1625 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
15381626
15391627#### Body parameters
15401628
from line 1907
18191907- `page: optional string`
18201908
18211909 Opaque cursor from a previous response's `next_page`.
1910
1911#### Headers
1912
1913- `"anthropic-version": optional string`
1914
1915 The version of the Claude API you want to use.
1916
1917 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
18221918
18231919#### Returns
18241920
from line 2111
20152111
20162112 ID of the federation issuer.
20172113
2114#### Headers
2115
2116- `"anthropic-version": optional string`
2117
2118 The version of the Claude API you want to use.
2119
2120 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2121
20182122#### Returns
20192123
20202124- `FederationIssuer object`
from line 2317
22132317
22142318 ID of the federation issuer to update.
22152319
2320#### Headers
2321
2322- `"anthropic-version": optional string`
2323
2324 The version of the Claude API you want to use.
2325
2326 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2327
22162328#### Body parameters
22172329
22182330- `check_jti: optional boolean or null`
from line 2601
24892601
24902602 ID of the federation issuer to archive.
24912603
2604#### Headers
2605
2606- `"anthropic-version": optional string`
2607
2608 The version of the Claude API you want to use.
2609
2610 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2611
24922612#### Returns
24932613
24942614- `FederationIssuer object`
from line 2810
26902810identity claims (e.g. `claims.repository_owner`). OAuth callers may only
26912811manage rules whose `oauth_scope` is `workspace:developer` or
26922812`workspace:inference`; other scopes require a Console session.
2813
2814#### Headers
2815
2816- `"anthropic-version": optional string`
2817
2818 The version of the Claude API you want to use.
2819
2820 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
26932821
26942822#### Body parameters
26952823
from line 3127
29993127- `page: optional string`
30003128
30013129 Opaque cursor from a previous response's `next_page`.
3130
3131#### Headers
3132
3133- `"anthropic-version": optional string`
3134
3135 The version of the Claude API you want to use.
3136
3137 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
30023138
30033139#### Returns
30043140
from line 3331
31953331
31963332 ID of the federation rule.
31973333
3334#### Headers
3335
3336- `"anthropic-version": optional string`
3337
3338 The version of the Claude API you want to use.
3339
3340 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3341
31983342#### Returns
31993343
32003344- `FederationRule object`
from line 3552
34083552
34093553 ID of the federation rule to update.
34103554
3555#### Headers
3556
3557- `"anthropic-version": optional string`
3558
3559 The version of the Claude API you want to use.
3560
3561 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3562
34113563#### Body parameters
34123564
34133565- `applies_to_all_workspaces: optional boolean or null`
from line 3845
36933845
36943846 ID of the federation rule to archive.
36953847
3848#### Headers
3849
3850- `"anthropic-version": optional string`
3851
3852 The version of the Claude API you want to use.
3853
3854 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3855
36963856#### Returns
36973857
36983858- `FederationRule object`
from line 4062
39024062
39034063 ID of the federation rule.
39044064
4065#### Headers
4066
4067- `"anthropic-version": optional string`
4068
4069 The version of the Claude API you want to use.
4070
4071 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4072
39054073#### Body parameters
39064074
39074075- `workspace_id: string`
from line 4162
39944162- `page: optional string`
39954163
39964164 Opaque cursor from a previous response's `next_page`.
4165
4166#### Headers
4167
4168- `"anthropic-version": optional string`
4169
4170 The version of the Claude API you want to use.
4171
4172 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
39974173
39984174#### Returns
39994175
from line 4254
40784254
40794255 ID of the workspace to disable for.
40804256
4257#### Headers
4258
4259- `"anthropic-version": optional string`
4260
4261 The version of the Claude API you want to use.
4262
4263 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4264
40814265#### Returns
40824266
40834267- `type: "federation_rule_workspace_deleted"`
from line 4304
41204304Invite a user to join the organization by email.
41214305
41224306On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat.
4307
4308#### Headers
4309
4310- `"anthropic-version": optional string`
4311
4312 The version of the Claude API you want to use.
4313
4314 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
41234315
41244316#### Body parameters
41254317
from line 4495
43034495 - `"expired"`
43044496
43054497 - `"pending"`
4498
4499#### Headers
4500
4501- `"anthropic-version": optional string`
4502
4503 The version of the Claude API you want to use.
4504
4505 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
43064506
43074507#### Returns
43084508
from line 4637
44374637
44384638 ID of the Invite.
44394639
4640#### Headers
4641
4642- `"anthropic-version": optional string`
4643
4644 The version of the Claude API you want to use.
4645
4646 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4647
44404648#### Returns
44414649
44424650- `OrganizationInvite object`
from line 4759
45514759
45524760 ID of the Invite.
45534761
4762#### Headers
4763
4764- `"anthropic-version": optional string`
4765
4766 The version of the Claude API you want to use.
4767
4768 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4769
45544770#### Returns
45554771
45564772- `type: "invite_deleted"`
from line 4816
46004816account requires an interactive credential (a user OAuth token or a
46014817Console session) — a workload may only create `developer`-role service
46024818accounts.
4819
4820#### Headers
4821
4822- `"anthropic-version": optional string`
4823
4824 The version of the Claude API you want to use.
4825
4826 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
46034827
46044828#### Body parameters
46054829
from line 4969
47454969- `page: optional string`
47464970
47474971 Opaque cursor from a previous response's `next_page`.
4972
4973#### Headers
4974
4975- `"anthropic-version": optional string`
4976
4977 The version of the Claude API you want to use.
4978
4979 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
47484980
47494981#### Returns
47504982
from line 5085
48535085
48545086 ID of the service account.
48555087
5088#### Headers
5089
5090- `"anthropic-version": optional string`
5091
5092 The version of the Claude API you want to use.
5093
5094 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5095
48565096#### Returns
48575097
48585098- `ServiceAccount object`
from line 5201
49615201
49625202 ID of the service account to update.
49635203
5204#### Headers
5205
5206- `"anthropic-version": optional string`
5207
5208 The version of the Claude API you want to use.
5209
5210 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5211
49645212#### Body parameters
49655213
49665214- `description: optional string or null`
from line 5335
50875335
50885336 ID of the service account to archive.
50895337
5338#### Headers
5339
5340- `"anthropic-version": optional string`
5341
5342 The version of the Claude API you want to use.
5343
5344 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5345
50905346#### Returns
50915347
50925348- `ServiceAccount object`
from line 5456
52005456
52015457 ID of the service account.
52025458
5459#### Headers
5460
5461- `"anthropic-version": optional string`
5462
5463 The version of the Claude API you want to use.
5464
5465 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5466
52035467#### Body parameters
52045468
52055469- `workspace_id: string`
from line 5585
53215585- `page: optional string`
53225586
53235587 Opaque cursor from a previous response's `next_page`.
5588
5589#### Headers
5590
5591- `"anthropic-version": optional string`
5592
5593 The version of the Claude API you want to use.
5594
5595 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
53245596
53255597#### Returns
53265598
from line 5688
54165688
54175689 ID of the workspace.
54185690
5691#### Headers
5692
5693- `"anthropic-version": optional string`
5694
5695 The version of the Claude API you want to use.
5696
5697 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5698
54195699#### Returns
54205700
54215701- `type: "service_account_workspace_member_deleted"`
from line 5766
54865766 Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
54875767
54885768 Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
5769
5770#### Headers
5771
5772- `"anthropic-version": optional string`
5773
5774 The version of the Claude API you want to use.
5775
5776 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
54895777
54905778#### Returns
54915779
from line 5879
55915879
55925880 ID of the User.
55935881
5882#### Headers
5883
5884- `"anthropic-version": optional string`
5885
5886 The version of the Claude API you want to use.
5887
5888 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5889
55945890#### Returns
55955891
55965892- `OrganizationUser object`
from line 5972
56765972
56775973 ID of the User.
56785974
5975#### Headers
5976
5977- `"anthropic-version": optional string`
5978
5979 The version of the Claude API you want to use.
5980
5981 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5982
56795983#### Body parameters
56805984
56815985- `role: "billing" or "claude_code_user" or "developer" or 2 more`
from line 6087
57836087
57846088 ID of the User.
57856089
6090#### Headers
6091
6092- `"anthropic-version": optional string`
6093
6094 The version of the Claude API you want to use.
6095
6096 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6097
57866098#### Returns
57876099
57886100- `type: "user_deleted"`
from line 6164
58526164 Defaults to `20`. Ranges from `1` to `1000`.
58536165
58546166 default: 20, minimum: 1, maximum: 1000
6167
6168#### Headers
6169
6170- `"anthropic-version": optional string`
6171
6172 The version of the Claude API you want to use.
6173
6174 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
58556175
58566176#### Returns
58576177
from line 6326
60066326
60076327Create Workspace
60086328
6329#### Headers
6330
6331- `"anthropic-version": optional string`
6332
6333 The version of the Claude API you want to use.
6334
6335 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6336
60096337#### Body parameters
60106338
60116339- `name: string`
from line 6544
62166544
62176545 ID of the Workspace.
62186546
6547#### Headers
6548
6549- `"anthropic-version": optional string`
6550
6551 The version of the Claude API you want to use.
6552
6553 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6554
62196555#### Returns
62206556
62216557- `Workspace object`
from line 6690
63546690
63556691- `workspace_id: string`
63566692
6693#### Headers
6694
6695- `"anthropic-version": optional string`
6696
6697 The version of the Claude API you want to use.
6698
6699 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6700
63576701#### Body parameters
63586702
63596703- `data_residency: optional DataResidencyUpdateConfig or null`
from line 6901
65576901
65586902- `workspace_id: string`
65596903
6904#### Headers
6905
6906- `"anthropic-version": optional string`
6907
6908 The version of the Claude API you want to use.
6909
6910 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6911
65606912#### Returns
65616913
65626914- `Workspace object`
from line 7097
67457097- `page: optional string`
67467098
67477099 Opaque cursor from a previous response's `next_page`.
7100
7101#### Headers
7102
7103- `"anthropic-version": optional string`
7104
7105 The version of the Claude API you want to use.
7106
7107 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
67487108
67497109#### Returns
67507110
from line 7342
69827342
69837343 default: 20, minimum: 1, maximum: 1000
69847344
7345#### Headers
7346
7347- `"anthropic-version": optional string`
7348
7349 The version of the Claude API you want to use.
7350
7351 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7352
69857353#### Returns
69867354
69877355- `data: array of WorkspaceMember`
from line 7434
70667434
70677435 ID of the Workspace.
70687436
7437#### Headers
7438
7439- `"anthropic-version": optional string`
7440
7441 The version of the Claude API you want to use.
7442
7443 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7444
70697445#### Body parameters
70707446
70717447- `user_id: string`
from line 7534
71587534
71597535 ID of the User.
71607536
7537#### Headers
7538
7539- `"anthropic-version": optional string`
7540
7541 The version of the Claude API you want to use.
7542
7543 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7544
71617545#### Returns
71627546
71637547- `WorkspaceMember object`
from line 7610
72267610- `user_id: string`
72277611
72287612 ID of the User.
7613
7614#### Headers
7615
7616- `"anthropic-version": optional string`
7617
7618 The version of the Claude API you want to use.
7619
7620 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
72297621
72307622#### Body parameters
72317623
from line 7708
73167708
73177709 ID of the User.
73187710
7711#### Headers
7712
7713- `"anthropic-version": optional string`
7714
7715 The version of the Claude API you want to use.
7716
7717 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7718
73197719#### Returns
73207720
73217721- `type: "workspace_member_deleted"`
from line 7787
73877787- `page: optional string`
73887788
73897789 Opaque cursor from a previous response's `next_page`.
7790
7791#### Headers
7792
7793- `"anthropic-version": optional string`
7794
7795 The version of the Claude API you want to use.
7796
7797 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
73907798
73917799#### Returns
73927800
from line 7887
74797887
74807888 ID of the workspace.
74817889
7890#### Headers
7891
7892- `"anthropic-version": optional string`
7893
7894 The version of the Claude API you want to use.
7895
7896 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7897
74827898#### Body parameters
74837899
74847900- `service_account_id: string`
from line 8002
75868002
75878003 ID of the service account.
75888004
8005#### Headers
8006
8007- `"anthropic-version": optional string`
8008
8009 The version of the Claude API you want to use.
8010
8011 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8012
75898013#### Returns
75908014
75918015- `ServiceAccountWorkspaceMember object`
from line 8094
76708094
76718095 ID of the service account.
76728096
8097#### Headers
8098
8099- `"anthropic-version": optional string`
8100
8101 The version of the Claude API you want to use.
8102
8103 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8104
76738105#### Body parameters
76748106
76758107- `workspace_role: NoBillingWorkspaceRole`
from line 8203
77718203
77728204 ID of the service account.
77738205
8206#### Headers
8207
8208- `"anthropic-version": optional string`
8209
8210 The version of the Claude API you want to use.
8211
8212 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8213
77748214#### Returns
77758215
77768216- `type: "service_account_workspace_member_deleted"`
from line 8293
78538293- `page: optional string`
78548294
78558295 Opaque cursor from a previous response's `next_page`.
8296
8297#### Headers
8298
8299- `"anthropic-version": optional string`
8300
8301 The version of the Claude API you want to use.
8302
8303 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
78568304
78578305#### Returns
78588306
from line 8486
80388486whether the Compliance API is enabled. An organization with a parent
80398487organization reads the state inherited from the parent's configuration.
80408488
8489#### Headers
8490
8491- `"anthropic-version": optional string`
8492
8493 The version of the Claude API you want to use.
8494
8495 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8496
80418497#### Returns
80428498
80438499- `OrganizationComplianceSettings object`
from line 8555
80998555provisioning (including re-runs) re-enables the Compliance API even
81008556after a `disabled` request. Automated provisioning never disables
81018557compliance settings.
8558
8559#### Headers
8560
8561- `"anthropic-version": optional string`
8562
8563 The version of the Claude API you want to use.
8564
8565 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
81028566
81038567#### Body parameters
81048568
81058569
api/organization/api_keys Changed · +24 / -0 lines
### Headers ### Headers ### Headers
from line 49
4949
5050 Filter by Workspace ID.
5151
52### Headers
53
54- `"anthropic-version": optional string`
55
56 The version of the Claude API you want to use.
57
58 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
59
5260### Returns
5361
5462- `data: array of APIKey`
from line 247
239247
240248 ID of the API key.
241249
250### Headers
251
252- `"anthropic-version": optional string`
253
254 The version of the Claude API you want to use.
255
256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
257
242258### Returns
243259
244260- `APIKey object`
from line 425
409425- `api_key_id: string`
410426
411427 ID of the API key.
428
429### Headers
430
431- `"anthropic-version": optional string`
432
433 The version of the Claude API you want to use.
434
435 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
412436
413437### Body parameters
414438
api/organization/api_keys/list Changed · +8 / -0 lines
## Headers
from line 47
4747
4848 Filter by Workspace ID.
4949
50## Headers
51
52- `"anthropic-version": optional string`
53
54 The version of the Claude API you want to use.
55
56 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
57
5058## Returns
5159
5260- `data: array of APIKey`
api/organization/api_keys/retrieve Changed · +8 / -0 lines
## Headers
from line 15
1515
1616 ID of the API key.
1717
18## Headers
19
20- `"anthropic-version": optional string`
21
22 The version of the Claude API you want to use.
23
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
25
1826## Returns
1927
2028- `APIKey object`
api/organization/api_keys/update Changed · +8 / -0 lines
## Headers
from line 15
1515
1616 ID of the API key.
1717
18## Headers
19
20- `"anthropic-version": optional string`
21
22 The version of the Claude API you want to use.
23
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
25
1826## Body parameters
1927
2028- `name: optional string or null`
api/organization/compliance_settings Changed · +16 / -0 lines
### Headers ### Headers
from line 16
1616whether the Compliance API is enabled. An organization with a parent
1717organization reads the state inherited from the parent's configuration.
1818
19### Headers
20
21- `"anthropic-version": optional string`
22
23 The version of the Claude API you want to use.
24
25 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
26
1927### Returns
2028
2129- `OrganizationComplianceSettings object`
from line 85
7785provisioning (including re-runs) re-enables the Compliance API even
7886after a `disabled` request. Automated provisioning never disables
7987compliance settings.
88
89### Headers
90
91- `"anthropic-version": optional string`
92
93 The version of the Claude API you want to use.
94
95 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8096
8197### Body parameters
8298
api/organization/compliance_settings/retrieve Changed · +8 / -0 lines
## Headers
from line 14
1414whether the Compliance API is enabled. An organization with a parent
1515organization reads the state inherited from the parent's configuration.
1616
17## Headers
18
19- `"anthropic-version": optional string`
20
21 The version of the Claude API you want to use.
22
23 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
24
1725## Returns
1826
1927- `OrganizationComplianceSettings object`
api/organization/compliance_settings/update Changed · +8 / -0 lines
## Headers
from line 22
2222after a `disabled` request. Automated provisioning never disables
2323compliance settings.
2424
25## Headers
26
27- `"anthropic-version": optional string`
28
29 The version of the Claude API you want to use.
30
31 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
32
2533## Body parameters
2634
2735- `state: ComplianceSettingsStateParam`
api/organization/external_keys Changed · +48 / -0 lines
### Headers ### Headers ### Headers ### Headers ### Headers ### Headers
from line 11
1111
1212Create an external key config owned by the caller's organization.
1313
14### Headers
15
16- `"anthropic-version": optional string`
17
18 The version of the Claude API you want to use.
19
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
21
1422### Body parameters
1523
1624- `provider_config: AWSExternalKeyConfig or GCPExternalKeyConfig or AzureExternalKeyConfigParam`
from line 245
237245
238246 Opaque cursor from a previous response's `next_page`.
239247
248### Headers
249
250- `"anthropic-version": optional string`
251
252 The version of the Claude API you want to use.
253
254 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
255
240256### Returns
241257
242258- `data: array of ExternalKey`
from line 402
386402
387403 maxLength: 2048
388404
405### Headers
406
407- `"anthropic-version": optional string`
408
409 The version of the Claude API you want to use.
410
411 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
412
389413### Returns
390414
391415- `ExternalKey object`
from line 560
536560
537561 maxLength: 2048
538562
563### Headers
564
565- `"anthropic-version": optional string`
566
567 The version of the Claude API you want to use.
568
569 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
570
539571### Body parameters
540572
541573- `display_name: optional string or null`
from line 784
752784
753785 maxLength: 2048
754786
787### Headers
788
789- `"anthropic-version": optional string`
790
791 The version of the Claude API you want to use.
792
793 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
794
755795### Returns
756796
757797- `type: "external_key_deleted"`
from line 838
798838 ID of the External Key.
799839
800840 maxLength: 2048
841
842### Headers
843
844- `"anthropic-version": optional string`
845
846 The version of the Claude API you want to use.
847
848 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
801849
802850### Returns
803851
api/organization/external_keys/create Changed · +8 / -0 lines
## Headers
from line 9
99
1010Create an external key config owned by the caller's organization.
1111
12## Headers
13
14- `"anthropic-version": optional string`
15
16 The version of the Claude API you want to use.
17
18 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
19
1220## Body parameters
1321
1422- `provider_config: AWSExternalKeyConfig or GCPExternalKeyConfig or AzureExternalKeyConfigParam`
api/organization/external_keys/delete Changed · +8 / -0 lines
## Headers
from line 19
1919
2020 maxLength: 2048
2121
22## Headers
23
24- `"anthropic-version": optional string`
25
26 The version of the Claude API you want to use.
27
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
29
2230## Returns
2331
2432- `type: "external_key_deleted"`
api/organization/external_keys/list Changed · +8 / -0 lines
## Headers
from line 24
2424
2525 Opaque cursor from a previous response's `next_page`.
2626
27## Headers
28
29- `"anthropic-version": optional string`
30
31 The version of the Claude API you want to use.
32
33 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
34
2735## Returns
2836
2937- `data: array of ExternalKey`
api/organization/external_keys/retrieve Changed · +8 / -0 lines
## Headers
from line 17
1717
1818 maxLength: 2048
1919
20## Headers
21
22- `"anthropic-version": optional string`
23
24 The version of the Claude API you want to use.
25
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
27
2028## Returns
2129
2230- `ExternalKey object`
api/organization/external_keys/update Changed · +8 / -0 lines
## Headers
from line 21
2121
2222 maxLength: 2048
2323
24## Headers
25
26- `"anthropic-version": optional string`
27
28 The version of the Claude API you want to use.
29
30 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
31
2432## Body parameters
2533
2634- `display_name: optional string or null`
api/organization/external_keys/validate Changed · +8 / -0 lines
## Headers
from line 22
2222
2323 maxLength: 2048
2424
25## Headers
26
27- `"anthropic-version": optional string`
28
29 The version of the Claude API you want to use.
30
31 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
32
2533## Returns
2634
2735- `type: "external_key_validation"`
api/organization/federation Changed · +104 / -0 lines
#### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers #### Headers
from line 25
2525document; for `explicit_url` and `inline` modes the issuer URL is only
2626matched as the JWT's `iss` claim and is not fetched.
2727
28#### Headers
29
30- `"anthropic-version": optional string`
31
32 The version of the Claude API you want to use.
33
34 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
35
2836#### Body parameters
2937
3038- `issuer_url: string`
from line 317
309317
310318 Opaque cursor from a previous response's `next_page`.
311319
320#### Headers
321
322- `"anthropic-version": optional string`
323
324 The version of the Claude API you want to use.
325
326 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
327
312328#### Returns
313329
314330- `data: array of FederationIssuer`
from line 520
504520
505521 ID of the federation issuer.
506522
523#### Headers
524
525- `"anthropic-version": optional string`
526
527 The version of the Claude API you want to use.
528
529 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
530
507531#### Returns
508532
509533- `FederationIssuer object`
from line 726
702726
703727 ID of the federation issuer to update.
704728
729#### Headers
730
731- `"anthropic-version": optional string`
732
733 The version of the Claude API you want to use.
734
735 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
736
705737#### Body parameters
706738
707739- `check_jti: optional boolean or null`
from line 1010
9781010
9791011 ID of the federation issuer to archive.
9801012
1013#### Headers
1014
1015- `"anthropic-version": optional string`
1016
1017 The version of the Claude API you want to use.
1018
1019 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1020
9811021#### Returns
9821022
9831023- `FederationIssuer object`
from line 1220
11801220manage rules whose `oauth_scope` is `workspace:developer` or
11811221`workspace:inference`; other scopes require a Console session.
11821222
1223#### Headers
1224
1225- `"anthropic-version": optional string`
1226
1227 The version of the Claude API you want to use.
1228
1229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1230
11831231#### Body parameters
11841232
11851233- `issuer_id: string`
from line 1537
14891537
14901538 Opaque cursor from a previous response's `next_page`.
14911539
1540#### Headers
1541
1542- `"anthropic-version": optional string`
1543
1544 The version of the Claude API you want to use.
1545
1546 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1547
14921548#### Returns
14931549
14941550- `data: array of FederationRule`
from line 1740
16841740
16851741 ID of the federation rule.
16861742
1743#### Headers
1744
1745- `"anthropic-version": optional string`
1746
1747 The version of the Claude API you want to use.
1748
1749 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1750
16871751#### Returns
16881752
16891753- `FederationRule object`
from line 1961
18971961
18981962 ID of the federation rule to update.
18991963
1964#### Headers
1965
1966- `"anthropic-version": optional string`
1967
1968 The version of the Claude API you want to use.
1969
1970 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1971
19001972#### Body parameters
19011973
19021974- `applies_to_all_workspaces: optional boolean or null`
from line 2254
21822254
21832255 ID of the federation rule to archive.
21842256
2257#### Headers
2258
2259- `"anthropic-version": optional string`
2260
2261 The version of the Claude API you want to use.
2262
2263 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2264
21852265#### Returns
21862266
21872267- `FederationRule object`
from line 2471
23912471
23922472 ID of the federation rule.
23932473
2474#### Headers
2475
2476- `"anthropic-version": optional string`
2477
2478 The version of the Claude API you want to use.
2479
2480 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2481
23942482#### Body parameters
23952483
23962484- `workspace_id: string`
from line 2572
24842572
24852573 Opaque cursor from a previous response's `next_page`.
24862574
2575#### Headers
2576
2577- `"anthropic-version": optional string`
2578
2579 The version of the Claude API you want to use.
2580
2581 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2582
24872583#### Returns
24882584
24892585- `data: array of FederationRuleWorkspace`
from line 2662
25662662- `workspace_id: string`
25672663
25682664 ID of the workspace to disable for.
2665
2666#### Headers
2667
2668- `"anthropic-version": optional string`
2669
2670 The version of the Claude API you want to use.
2671
2672 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
25692673
25702674#### Returns
25712675
api/organization/federation/issuers Changed · +40 / -0 lines
### Headers ### Headers ### Headers ### Headers ### Headers
from line 23
2323document; for `explicit_url` and `inline` modes the issuer URL is only
2424matched as the JWT's `iss` claim and is not fetched.
2525
26### Headers
27
28- `"anthropic-version": optional string`
29
30 The version of the Claude API you want to use.
31
32 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
33
2634### Body parameters
2735
2836- `issuer_url: string`
from line 315
307315
308316 Opaque cursor from a previous response's `next_page`.
309317
318### Headers
319
320- `"anthropic-version": optional string`
321
322 The version of the Claude API you want to use.
323
324 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
325
310326### Returns
311327
312328- `data: array of FederationIssuer`
from line 518
502518
503519 ID of the federation issuer.
504520
521### Headers
522
523- `"anthropic-version": optional string`
524
525 The version of the Claude API you want to use.
526
527 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
528
505529### Returns
506530
507531- `FederationIssuer object`
from line 724
700724
701725 ID of the federation issuer to update.
702726
727### Headers
728
729- `"anthropic-version": optional string`
730
731 The version of the Claude API you want to use.
732
733 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
734
703735### Body parameters
704736
705737- `check_jti: optional boolean or null`
from line 1007
9751007- `federation_issuer_id: string`
9761008
9771009 ID of the federation issuer to archive.
1010
1011### Headers
1012
1013- `"anthropic-version": optional string`
1014
1015 The version of the Claude API you want to use.
1016
1017 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
9781018
9791019### Returns
9801020
api/organization/federation/issuers/archive Changed · +8 / -0 lines
## Headers
from line 22
2222
2323 ID of the federation issuer to archive.
2424
25## Headers
26
27- `"anthropic-version": optional string`
28
29 The version of the Claude API you want to use.
30
31 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
32
2533## Returns
2634
2735- `FederationIssuer object`
api/organization/federation/issuers/create Changed · +8 / -0 lines
## Headers
from line 21
2121document; for `explicit_url` and `inline` modes the issuer URL is only
2222matched as the JWT's `iss` claim and is not fetched.
2323
24## Headers
25
26- `"anthropic-version": optional string`
27
28 The version of the Claude API you want to use.
29
30 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
31
2432## Body parameters
2533
2634- `issuer_url: string`
api/organization/federation/issuers/list Changed · +8 / -0 lines
## Headers
from line 31
3131
3232 Opaque cursor from a previous response's `next_page`.
3333
34## Headers
35
36- `"anthropic-version": optional string`
37
38 The version of the Claude API you want to use.
39
40 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
41
3442## Returns
3543
3644- `data: array of FederationIssuer`
api/organization/federation/issuers/retrieve Changed · +8 / -0 lines
## Headers
from line 17
1717
1818 ID of the federation issuer.
1919
20## Headers
21
22- `"anthropic-version": optional string`
23
24 The version of the Claude API you want to use.
25
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
27
2028## Returns
2129
2230- `FederationIssuer object`
api/organization/federation/issuers/update Changed · +8 / -0 lines
## Headers
from line 24
2424
2525 ID of the federation issuer to update.
2626
27## Headers
28
29- `"anthropic-version": optional string`
30
31 The version of the Claude API you want to use.
32
33 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
34
2735## Body parameters
2836
2937- `check_jti: optional boolean or null`
api/organization/federation/rules Changed · +64 / -0 lines
### Headers ### Headers ### Headers ### Headers ### Headers #### Headers #### Headers #### Headers
from line 27
2727manage rules whose `oauth_scope` is `workspace:developer` or
2828`workspace:inference`; other scopes require a Console session.
2929
30### Headers
31
32- `"anthropic-version": optional string`
33
34 The version of the Claude API you want to use.
35
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
37
3038### Body parameters
3139
3240- `issuer_id: string`
from line 344
336344
337345 Opaque cursor from a previous response's `next_page`.
338346
347### Headers
348
349- `"anthropic-version": optional string`
350
351 The version of the Claude API you want to use.
352
353 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
354
339355### Returns
340356
341357- `data: array of FederationRule`
from line 547
531547
532548 ID of the federation rule.
533549
550### Headers
551
552- `"anthropic-version": optional string`
553
554 The version of the Claude API you want to use.
555
556 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
557
534558### Returns
535559
536560- `FederationRule object`
from line 768
744768
745769 ID of the federation rule to update.
746770
771### Headers
772
773- `"anthropic-version": optional string`
774
775 The version of the Claude API you want to use.
776
777 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
778
747779### Body parameters
748780
749781- `applies_to_all_workspaces: optional boolean or null`
from line 1061
10291061
10301062 ID of the federation rule to archive.
10311063
1064### Headers
1065
1066- `"anthropic-version": optional string`
1067
1068 The version of the Claude API you want to use.
1069
1070 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1071
10321072### Returns
10331073
10341074- `FederationRule object`
from line 1491
14511491
14521492 ID of the federation rule.
14531493
1494#### Headers
1495
1496- `"anthropic-version": optional string`
1497
1498 The version of the Claude API you want to use.
1499
1500 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1501
14541502#### Body parameters
14551503
14561504- `workspace_id: string`
from line 1592
15441592
15451593 Opaque cursor from a previous response's `next_page`.
15461594
1595#### Headers
1596
1597- `"anthropic-version": optional string`
1598
1599 The version of the Claude API you want to use.
1600
1601 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1602
15471603#### Returns
15481604
15491605- `data: array of FederationRuleWorkspace`
from line 1682
16261682- `workspace_id: string`
16271683
16281684 ID of the workspace to disable for.
1685
1686#### Headers
1687
1688- `"anthropic-version": optional string`
1689
1690 The version of the Claude API you want to use.
1691
1692 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
16291693
16301694#### Returns
16311695
api/organization/federation/rules/archive Changed · +8 / -0 lines
## Headers
from line 25
2525
2626 ID of the federation rule to archive.
2727
28## Headers
29
30- `"anthropic-version": optional string`
31
32 The version of the Claude API you want to use.
33
34 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
35
2836## Returns
2937
3038- `FederationRule object`
api/organization/federation/rules/create Changed · +8 / -0 lines
## Headers
from line 25
2525manage rules whose `oauth_scope` is `workspace:developer` or
2626`workspace:inference`; other scopes require a Console session.
2727
28## Headers
29
30- `"anthropic-version": optional string`
31
32 The version of the Claude API you want to use.
33
34 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
35
2836## Body parameters
2937
3038- `issuer_id: string`