What this read moved
51–75 of 239This capture is too large to show at once. Changes 51-75 of 239 are below, significant first; the rest are on the following screens.
api/beta/organization/rate_limits Changed · +292 / -35 lines
### Beta Organization Rate Limit Batch Group ### Beta Organization Rate Limit Files Group ### Beta Organization Rate Limit Model Group ### Beta Organization Rate Limit Skills Group ### Beta Organization Rate Limit Token Count Group ### Beta Organization Rate Limit Web Search Group
from line 67
6767
6868 - `id: string`
6969
70 Stable identifier for this rate-limit group within the organization.
70 Identifier of this rate-limit entry. It is stable within the organization and differs between organizations; the group's own identifier is `group.id`.
7171
72 - `group_type: "batch" or "files" or "model_group" or 3 more`
72 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
7373
74 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
74 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
7575
76 - `"batch"`
76 - `BetaOrganizationRateLimitModelGroup object`
7777
78 - `"files"`
78 - `type: "model_group"`
7979
80 - `"model_group"`
80 Always `model_group`: a family of models.
8181
82 - `"skills"`
82 default: model_group
8383
84 - `"token_count"`
84 - `id: string`
8585
86 - `"web_search"`
86 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
8787
88 - `display_name: string`
89
90 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
91
92 - `BetaOrganizationRateLimitBatchGroup object`
93
94 - `type: "batch"`
95
96 Always `batch`: the Message Batches API.
97
98 default: batch
99
100 - `id: string`
101
102 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
103
104 - `BetaOrganizationRateLimitTokenCountGroup object`
105
106 - `type: "token_count"`
107
108 Always `token_count`: the Token Count API.
109
110 default: token_count
111
112 - `id: string`
113
114 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
115
116 - `BetaOrganizationRateLimitFilesGroup object`
117
118 - `type: "files"`
119
120 Always `files`: the Files API.
121
122 default: files
123
124 - `id: string`
125
126 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
127
128 - `BetaOrganizationRateLimitSkillsGroup object`
129
130 - `type: "skills"`
131
132 Always `skills`: the Skills API.
133
134 default: skills
135
136 - `id: string`
137
138 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
139
140 - `BetaOrganizationRateLimitWebSearchGroup object`
141
142 - `type: "web_search"`
143
144 Always `web_search`: the Messages API web search tool.
145
146 default: web_search
147
148 - `id: string`
149
150 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
151
88152 - `limits: array of BetaOrganizationRateLimitValue`
89153
90154 The limiter values that apply to this group.
from line 165
101165
102166 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
103167
168 - `group_type: "batch" or "files" or "model_group" or 3 more`
169
170 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
171
172 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
173
174 - `"batch"`
175
176 - `"files"`
177
178 - `"model_group"`
179
180 - `"skills"`
181
182 - `"token_count"`
183
184 - `"web_search"`
185
104186- `next_page: string or null`
105187
106188 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
from line 202
120202 "data": [
121203 {
122204 "id": "id",
205 "group": {
206 "id": "id",
207 "display_name": "display_name",
208 "type": "model_group"
209 },
123210 "group_type": "batch",
124211 "limits": [
125212 {
from line 238
151238
152239 - `id: string`
153240
154 Stable identifier for this rate-limit group within the organization.
241 Identifier of this rate-limit entry. It is stable within the organization and differs between organizations; the group's own identifier is `group.id`.
155242
156 - `group_type: "batch" or "files" or "model_group" or 3 more`
243 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
157244
158 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
245 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
159246
160 - `"batch"`
247 - `BetaOrganizationRateLimitModelGroup object`
161248
162 - `"files"`
249 - `type: "model_group"`
163250
164 - `"model_group"`
251 Always `model_group`: a family of models.
165252
166 - `"skills"`
253 default: model_group
167254
168 - `"token_count"`
255 - `id: string`
169256
170 - `"web_search"`
257 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
171258
259 - `display_name: string`
260
261 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
262
263 - `BetaOrganizationRateLimitBatchGroup object`
264
265 - `type: "batch"`
266
267 Always `batch`: the Message Batches API.
268
269 default: batch
270
271 - `id: string`
272
273 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
274
275 - `BetaOrganizationRateLimitTokenCountGroup object`
276
277 - `type: "token_count"`
278
279 Always `token_count`: the Token Count API.
280
281 default: token_count
282
283 - `id: string`
284
285 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
286
287 - `BetaOrganizationRateLimitFilesGroup object`
288
289 - `type: "files"`
290
291 Always `files`: the Files API.
292
293 default: files
294
295 - `id: string`
296
297 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
298
299 - `BetaOrganizationRateLimitSkillsGroup object`
300
301 - `type: "skills"`
302
303 Always `skills`: the Skills API.
304
305 default: skills
306
307 - `id: string`
308
309 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
310
311 - `BetaOrganizationRateLimitWebSearchGroup object`
312
313 - `type: "web_search"`
314
315 Always `web_search`: the Messages API web search tool.
316
317 default: web_search
318
319 - `id: string`
320
321 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
322
172323 - `limits: array of BetaOrganizationRateLimitValue`
173324
174325 The limiter values that apply to this group.
from line 336
185336
186337 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
187338
339 - `group_type: "batch" or "files" or "model_group" or 3 more`
340
341 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
342
343 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
344
345 - `"batch"`
346
347 - `"files"`
348
349 - `"model_group"`
350
351 - `"skills"`
352
353 - `"token_count"`
354
355 - `"web_search"`
356
357### Beta Organization Rate Limit Batch Group
358
359- `BetaOrganizationRateLimitBatchGroup object`
360
361 - `type: "batch"`
362
363 Always `batch`: the Message Batches API.
364
365 default: batch
366
367 - `id: string`
368
369 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
370
371### Beta Organization Rate Limit Files Group
372
373- `BetaOrganizationRateLimitFilesGroup object`
374
375 - `type: "files"`
376
377 Always `files`: the Files API.
378
379 default: files
380
381 - `id: string`
382
383 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
384
385### Beta Organization Rate Limit Model Group
386
387- `BetaOrganizationRateLimitModelGroup object`
388
389 - `type: "model_group"`
390
391 Always `model_group`: a family of models.
392
393 default: model_group
394
395 - `id: string`
396
397 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
398
399 - `display_name: string`
400
401 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
402
403### Beta Organization Rate Limit Skills Group
404
405- `BetaOrganizationRateLimitSkillsGroup object`
406
407 - `type: "skills"`
408
409 Always `skills`: the Skills API.
410
411 default: skills
412
413 - `id: string`
414
415 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
416
417### Beta Organization Rate Limit Token Count Group
418
419- `BetaOrganizationRateLimitTokenCountGroup object`
420
421 - `type: "token_count"`
422
423 Always `token_count`: the Token Count API.
424
425 default: token_count
426
427 - `id: string`
428
429 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
430
188431### Beta Organization Rate Limit Value
189432
190433- `BetaOrganizationRateLimitValue object`
from line 439
196439 - `value: number`
197440
198441 The configured limit value for this limiter type.
442
443### Beta Organization Rate Limit Web Search Group
444
445- `BetaOrganizationRateLimitWebSearchGroup object`
446
447 - `type: "web_search"`
448
449 Always `web_search`: the Messages API web search tool.
450
451 default: web_search
452
453 - `id: string`
454
455 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
199456
api/beta/organization/rate_limits/list Changed · +105 / -18 lines
from line 65
6565
6666 - `id: string`
6767
68 Stable identifier for this rate-limit group within the organization.
68 Identifier of this rate-limit entry. It is stable within the organization and differs between organizations; the group's own identifier is `group.id`.
6969
70 - `group_type: "batch" or "files" or "model_group" or 3 more`
70 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
7171
72 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
72 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
7373
74 - `"batch"`
74 - `BetaOrganizationRateLimitModelGroup object`
7575
76 - `"files"`
76 - `type: "model_group"`
7777
78 - `"model_group"`
78 Always `model_group`: a family of models.
7979
80 - `"skills"`
80 default: model_group
8181
82 - `"token_count"`
82 - `id: string`
8383
84 - `"web_search"`
84 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
8585
86 - `display_name: string`
87
88 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
89
90 - `BetaOrganizationRateLimitBatchGroup object`
91
92 - `type: "batch"`
93
94 Always `batch`: the Message Batches API.
95
96 default: batch
97
98 - `id: string`
99
100 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
101
102 - `BetaOrganizationRateLimitTokenCountGroup object`
103
104 - `type: "token_count"`
105
106 Always `token_count`: the Token Count API.
107
108 default: token_count
109
110 - `id: string`
111
112 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
113
114 - `BetaOrganizationRateLimitFilesGroup object`
115
116 - `type: "files"`
117
118 Always `files`: the Files API.
119
120 default: files
121
122 - `id: string`
123
124 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
125
126 - `BetaOrganizationRateLimitSkillsGroup object`
127
128 - `type: "skills"`
129
130 Always `skills`: the Skills API.
131
132 default: skills
133
134 - `id: string`
135
136 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
137
138 - `BetaOrganizationRateLimitWebSearchGroup object`
139
140 - `type: "web_search"`
141
142 Always `web_search`: the Messages API web search tool.
143
144 default: web_search
145
146 - `id: string`
147
148 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
149
86150 - `limits: array of BetaOrganizationRateLimitValue`
87151
88152 The limiter values that apply to this group.
from line 163
99163
100164 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
101165
166 - `group_type: "batch" or "files" or "model_group" or 3 more`
167
168 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
169
170 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
171
172 - `"batch"`
173
174 - `"files"`
175
176 - `"model_group"`
177
178 - `"skills"`
179
180 - `"token_count"`
181
182 - `"web_search"`
183
102184- `next_page: string or null`
103185
104186 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
from line 200
118200 "data": [
119201 {
120202 "id": "id",
203 "group": {
204 "id": "id",
205 "display_name": "display_name",
206 "type": "model_group"
207 },
121208 "group_type": "batch",
122209 "limits": [
123210 {
api/beta/organization/rbac_groups Changed · +171 / -108 lines
from line 53
5353
5454 Name of the RBAC Group. Not uniqueness-enforced.
5555
56 - `roles: array of string or null`
56 - `role_ids: array of string or null`
5757
5858 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
5959
from line 71
7171
7272 format: date-time
7373
74 - `roles: array of string or null`
75
76 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
77
78 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
79
7480- `has_more: boolean`
7581
7682 Indicates if there are more results in the requested page direction.
from line 102
96102 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
97103 "created_at": "2024-10-30T23:58:27.427722Z",
98104 "name": "Engineering",
105 "role_ids": [
106 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
107 ],
99108 "roles": [
100109 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
101110 ],
from line 120
111120
112121## Get RBAC Group
113122
114**GET** `/v1/organizations/rbac_groups/{group_id}`
123**GET** `/v1/organizations/rbac_groups/{rbac_group_id}`
115124
116125Retrieve an RBAC Group by ID.
117126
from line 128
119128
120129### Path parameters
121130
122- `group_id: string`
131- `rbac_group_id: string`
123132
124133 ID of the RBAC Group.
125134
from line 158
149158
150159 Name of the RBAC Group. Not uniqueness-enforced.
151160
152 - `roles: array of string or null`
161 - `role_ids: array of string or null`
153162
154163 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
155164
from line 176
167176
168177 format: date-time
169178
179 - `roles: array of string or null`
180
181 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
182
183 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
184
170185### Example
171186
172187```bash
173curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
188curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
174189 -H 'anthropic-version: 2023-06-01' \
175190 -H "X-Api-Key: $ANTHROPIC_API_KEY"
176191```
from line 197
182197 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
183198 "created_at": "2024-10-30T23:58:27.427722Z",
184199 "name": "Engineering",
200 "role_ids": [
201 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
202 ],
185203 "roles": [
186204 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
187205 ],
from line 251
233251
234252 Name of the RBAC Group. Not uniqueness-enforced.
235253
236 - `roles: array of string or null`
254 - `role_ids: array of string or null`
237255
238256 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
239257
from line 269
251269
252270 format: date-time
253271
272 - `roles: array of string or null`
273
274 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
275
276 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
277
254278### Example
255279
256280```bash
from line 294
270294 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
271295 "created_at": "2024-10-30T23:58:27.427722Z",
272296 "name": "Engineering",
297 "role_ids": [
298 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
299 ],
273300 "roles": [
274301 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
275302 ],
from line 308
281308
282309## Update RBAC Group
283310
284**POST** `/v1/organizations/rbac_groups/{group_id}`
311**POST** `/v1/organizations/rbac_groups/{rbac_group_id}`
285312
286313Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
287314
from line 316
289316
290317### Path parameters
291318
292- `group_id: string`
319- `rbac_group_id: string`
293320
294321 ID of the RBAC Group.
295322
from line 354
327354
328355 Name of the RBAC Group. Not uniqueness-enforced.
329356
330 - `roles: array of string or null`
357 - `role_ids: array of string or null`
331358
332359 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
333360
from line 372
345372
346373 format: date-time
347374
375 - `roles: array of string or null`
376
377 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
378
379 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
380
348381### Example
349382
350383```bash
351curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
384curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
352385 -H 'Content-Type: application/json' \
353386 -H 'anthropic-version: 2023-06-01' \
354387 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
from line 397
364397 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
365398 "created_at": "2024-10-30T23:58:27.427722Z",
366399 "name": "Engineering",
400 "role_ids": [
401 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
402 ],
367403 "roles": [
368404 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
369405 ],
from line 411
375411
376412## Delete RBAC Group
377413
378**DELETE** `/v1/organizations/rbac_groups/{group_id}`
414**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}`
379415
380416Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API while an organization in the tenant uses SCIM provisioning.
381417
from line 419
383419
384420### Path parameters
385421
386- `group_id: string`
422- `rbac_group_id: string`
387423
388424 ID of the RBAC Group.
389425
from line 442
406442### Example
407443
408444```bash
409curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
445curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
410446 -X DELETE \
411447 -H 'anthropic-version: 2023-06-01' \
412448 -H "X-Api-Key: $ANTHROPIC_API_KEY"
from line 485
449485
450486 Name of the RBAC Group. Not uniqueness-enforced.
451487
452 - `roles: array of string or null`
488 - `role_ids: array of string or null`
453489
454490 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
455491
from line 503
467503
468504 format: date-time
469505
506 - `roles: array of string or null`
507
508 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
509
510 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
511
470512### Beta RBAC Group Deleted
471513
472514- `BetaRBACGroupDeleted object`
from line 529
487529
488530### List RBAC Group Members
489531
490**GET** `/v1/organizations/rbac_groups/{group_id}/members`
532**GET** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
491533
492534List members of an RBAC Group.
493535
from line 537
495537
496538#### Path parameters
497539
498- `group_id: string`
540- `rbac_group_id: string`
499541
500542 ID of the RBAC Group.
501543
from line 577
535577
536578 Email of the User.
537579
538 - `group_id: string`
580 - `rbac_group_id: string`
539581
540582 ID of the RBAC Group.
541583
from line 585
543585
544586 ID of the User.
545587
588 - `group_id: string`
589
590 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
591
592 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
593
546594- `has_more: boolean`
547595
548596 Indicates if there are more results in the requested page direction.
from line 602
554602#### Example
555603
556604```bash
557curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
605curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
558606 -H 'anthropic-version: 2023-06-01' \
559607 -H "X-Api-Key: $ANTHROPIC_API_KEY"
560608```
from line 616
568616 "created_at": "2024-10-30T23:58:27.427722Z",
570618 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
619 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
571620 "type": "rbac_group_member",
572621 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
573622 }
from line 628
579628
580629### Add RBAC Group Member
581630
582**POST** `/v1/organizations/rbac_groups/{group_id}/members`
631**POST** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
583632
584633Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
585634
from line 636
587636
588637#### Path parameters
589638
590- `group_id: string`
639- `rbac_group_id: string`
591640
592641 ID of the RBAC Group.
593642
from line 668
619668
620669 Email of the User.
621670
622 - `group_id: string`
671 - `rbac_group_id: string`
623672
624673 ID of the RBAC Group.
625674
from line 676
627676
628677 ID of the User.
629678
679 - `group_id: string`
680
681 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
682
683 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
684
630685#### Example
631686
632687```bash
633curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
688curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
634689 -H 'Content-Type: application/json' \
635690 -H 'anthropic-version: 2023-06-01' \
636691 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
from line 701
646701 "created_at": "2024-10-30T23:58:27.427722Z",
648703 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
704 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
649705 "type": "rbac_group_member",
650706 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
651707}
from line 709
653709
654710### Remove RBAC Group Member
655711
656**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
712**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}`
657713
658714Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
659715
from line 717
661717
662718#### Path parameters
663719
664- `group_id: string`
720- `rbac_group_id: string`
665721
666722 ID of the RBAC Group.
667723
from line 735
679735
680736 default: rbac_group_member_deleted
681737
682 - `group_id: string`
738 - `rbac_group_id: string`
683739
684740 ID of the RBAC Group.
685741
from line 743
687743
688744 ID of the User.
689745
746 - `group_id: string`
747
748 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
749
750 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
751
690752#### Example
691753
692754```bash
693curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
755curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \
694756 -X DELETE \
695757 -H 'anthropic-version: 2023-06-01' \
696758 -H "X-Api-Key: $ANTHROPIC_API_KEY"
from line 763
701763```json
702764{
703765 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
766 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
704767 "type": "rbac_group_member_deleted",
705768 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
706769}
api/beta/organization/rbac_groups/create Changed · +10 / -1 lines
from line 45
4545
4646 Name of the RBAC Group. Not uniqueness-enforced.
4747
48 - `roles: array of string or null`
48 - `role_ids: array of string or null`
4949
5050 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
5151
from line 63
6363
6464 format: date-time
6565
66 - `roles: array of string or null`
67
68 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
69
70 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
71
6672## Example
6773
6874```bash
from line 88
8288 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
8389 "created_at": "2024-10-30T23:58:27.427722Z",
8490 "name": "Engineering",
91 "role_ids": [
92 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
93 ],
8594 "roles": [
8695 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
8796 ],
api/beta/organization/rbac_groups/delete Changed · +3 / -3 lines
from line 5
55
66# Delete RBAC Group
77
8**DELETE** `/v1/organizations/rbac_groups/{group_id}`
8**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}`
99
1010Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API while an organization in the tenant uses SCIM provisioning.
1111
from line 13
1313
1414## Path parameters
1515
16- `group_id: string`
16- `rbac_group_id: string`
1717
1818 ID of the RBAC Group.
1919
from line 36
3636## Example
3737
3838```bash
39curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
39curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
4040 -X DELETE \
4141 -H 'anthropic-version: 2023-06-01' \
4242 -H "X-Api-Key: $ANTHROPIC_API_KEY"
api/beta/organization/rbac_groups/list Changed · +10 / -1 lines
from line 51
5151
5252 Name of the RBAC Group. Not uniqueness-enforced.
5353
54 - `roles: array of string or null`
54 - `role_ids: array of string or null`
5555
5656 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
5757
from line 69
6969
7070 format: date-time
7171
72 - `roles: array of string or null`
73
74 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
75
76 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
77
7278- `has_more: boolean`
7379
7480 Indicates if there are more results in the requested page direction.
from line 100
94100 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
95101 "created_at": "2024-10-30T23:58:27.427722Z",
96102 "name": "Engineering",
103 "role_ids": [
104 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
105 ],
97106 "roles": [
98107 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
99108 ],
api/beta/organization/rbac_groups/members Changed · +77 / -44 lines
from line 7
77
88## List RBAC Group Members
99
10**GET** `/v1/organizations/rbac_groups/{group_id}/members`
10**GET** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
1111
1212List members of an RBAC Group.
1313
from line 15
1515
1616### Path parameters
1717
18- `group_id: string`
18- `rbac_group_id: string`
1919
2020 ID of the RBAC Group.
2121
from line 55
5555
5656 Email of the User.
5757
58 - `group_id: string`
58 - `rbac_group_id: string`
5959
6060 ID of the RBAC Group.
6161
from line 63
6363
6464 ID of the User.
6565
66 - `group_id: string`
67
68 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
69
70 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
71
6672- `has_more: boolean`
6773
6874 Indicates if there are more results in the requested page direction.
from line 80
7480### Example
7581
7682```bash
77curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
83curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
7884 -H 'anthropic-version: 2023-06-01' \
7985 -H "X-Api-Key: $ANTHROPIC_API_KEY"
8086```
from line 94
8894 "created_at": "2024-10-30T23:58:27.427722Z",
9096 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
97 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
9198 "type": "rbac_group_member",
9299 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
93100 }
from line 106
99106
100107## Add RBAC Group Member
101108
102**POST** `/v1/organizations/rbac_groups/{group_id}/members`
109**POST** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
103110
104111Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
105112
from line 114
107114
108115### Path parameters
109116
110- `group_id: string`
117- `rbac_group_id: string`
111118
112119 ID of the RBAC Group.
113120
from line 146
139146
140147 Email of the User.
141148
142 - `group_id: string`
149 - `rbac_group_id: string`
143150
144151 ID of the RBAC Group.
145152
from line 154
147154
148155 ID of the User.
149156
157 - `group_id: string`
158
159 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
160
161 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
162
150163### Example
151164
152165```bash
153curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
166curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
154167 -H 'Content-Type: application/json' \
155168 -H 'anthropic-version: 2023-06-01' \
156169 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
from line 179
166179 "created_at": "2024-10-30T23:58:27.427722Z",
168181 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
182 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
169183 "type": "rbac_group_member",
170184 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
171185}
from line 187
173187
174188## Remove RBAC Group Member
175189
176**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
190**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}`
177191
178192Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
179193
from line 195
181195
182196### Path parameters
183197
184- `group_id: string`
198- `rbac_group_id: string`
185199
186200 ID of the RBAC Group.
187201
from line 213
199213
200214 default: rbac_group_member_deleted
201215
202 - `group_id: string`
216 - `rbac_group_id: string`
203217
204218 ID of the RBAC Group.
205219
from line 221
207221
208222 ID of the User.
209223
224 - `group_id: string`
225
226 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
227
228 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
229
210230### Example
211231
212232```bash
213curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
233curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \
214234 -X DELETE \
215235 -H 'anthropic-version: 2023-06-01' \
216236 -H "X-Api-Key: $ANTHROPIC_API_KEY"
from line 241
221241```json
222242{
223243 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
244 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
224245 "type": "rbac_group_member_deleted",
225246 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
226247}
from line 271
250271
251272 Email of the User.
252273
253 - `group_id: string`
274 - `rbac_group_id: string`
254275
255276 ID of the RBAC Group.
256277
from line 279
258279
259280 ID of the User.
260281
282 - `group_id: string`
283
284 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
285
286 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
287
261288### Beta RBAC Group Member Deleted
262289
263290- `BetaRBACGroupMemberDeleted object`
from line 295
268295
269296 default: rbac_group_member_deleted
270297
271 - `group_id: string`
298 - `rbac_group_id: string`
272299
273300 ID of the RBAC Group.
274301
from line 302
275302 - `user_id: string`
276303
277304 ID of the User.
305
306 - `group_id: string`
307
308 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
309
310 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
278311
api/beta/organization/rbac_groups/members/create Changed · +11 / -4 lines
from line 5
55
66# Add RBAC Group Member
77
8**POST** `/v1/organizations/rbac_groups/{group_id}/members`
8**POST** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
99
1010Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
1111
from line 13
1313
1414## Path parameters
1515
16- `group_id: string`
16- `rbac_group_id: string`
1717
1818 ID of the RBAC Group.
1919
from line 45
4545
4646 Email of the User.
4747
48 - `group_id: string`
48 - `rbac_group_id: string`
4949
5050 ID of the RBAC Group.
5151
from line 53
5353
5454 ID of the User.
5555
56 - `group_id: string`
57
58 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
59
60 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
61
5662## Example
5763
5864```bash
59curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
65curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
6066 -H 'Content-Type: application/json' \
6167 -H 'anthropic-version: 2023-06-01' \
6268 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
from line 78
7278 "created_at": "2024-10-30T23:58:27.427722Z",
7480 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
81 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
7582 "type": "rbac_group_member",
7683 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
7784}
api/beta/organization/rbac_groups/members/delete Changed · +11 / -4 lines
from line 5
55
66# Remove RBAC Group Member
77
8**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
8**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}`
99
1010Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
1111
from line 13
1313
1414## Path parameters
1515
16- `group_id: string`
16- `rbac_group_id: string`
1717
1818 ID of the RBAC Group.
1919
from line 31
3131
3232 default: rbac_group_member_deleted
3333
34 - `group_id: string`
34 - `rbac_group_id: string`
3535
3636 ID of the RBAC Group.
3737
from line 39
3939
4040 ID of the User.
4141
42 - `group_id: string`
43
44 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
45
46 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
47
4248## Example
4349
4450```bash
45curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
51curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \
4652 -X DELETE \
4753 -H 'anthropic-version: 2023-06-01' \
4854 -H "X-Api-Key: $ANTHROPIC_API_KEY"
from line 59
5359```json
5460{
5561 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
62 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
5663 "type": "rbac_group_member_deleted",
5764 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
5865}
api/beta/organization/rbac_groups/members/list Changed · +11 / -4 lines
from line 5
55
66# List RBAC Group Members
77
8**GET** `/v1/organizations/rbac_groups/{group_id}/members`
8**GET** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
99
1010List members of an RBAC Group.
1111
from line 13
1313
1414## Path parameters
1515
16- `group_id: string`
16- `rbac_group_id: string`
1717
1818 ID of the RBAC Group.
1919
from line 53
5353
5454 Email of the User.
5555
56 - `group_id: string`
56 - `rbac_group_id: string`
5757
5858 ID of the RBAC Group.
5959
from line 61
6161
6262 ID of the User.
6363
64 - `group_id: string`
65
66 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
67
68 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
69
6470- `has_more: boolean`
6571
6672 Indicates if there are more results in the requested page direction.
from line 78
7278## Example
7379
7480```bash
75curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
81curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
7682 -H 'anthropic-version: 2023-06-01' \
7783 -H "X-Api-Key: $ANTHROPIC_API_KEY"
7884```
from line 92
8692 "created_at": "2024-10-30T23:58:27.427722Z",
8894 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
95 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
8996 "type": "rbac_group_member",
9097 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
9198 }
api/beta/organization/rbac_groups/retrieve Changed · +13 / -4 lines
from line 5
55
66# Get RBAC Group
77
8**GET** `/v1/organizations/rbac_groups/{group_id}`
8**GET** `/v1/organizations/rbac_groups/{rbac_group_id}`
99
1010Retrieve an RBAC Group by ID.
1111
from line 13
1313
1414## Path parameters
1515
16- `group_id: string`
16- `rbac_group_id: string`
1717
1818 ID of the RBAC Group.
1919
from line 43
4343
4444 Name of the RBAC Group. Not uniqueness-enforced.
4545
46 - `roles: array of string or null`
46 - `role_ids: array of string or null`
4747
4848 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
4949
from line 61
6161
6262 format: date-time
6363
64 - `roles: array of string or null`
65
66 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
67
68 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
69
6470## Example
6571
6672```bash
67curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
73curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
6874 -H 'anthropic-version: 2023-06-01' \
6975 -H "X-Api-Key: $ANTHROPIC_API_KEY"
7076```
from line 82
7682 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
7783 "created_at": "2024-10-30T23:58:27.427722Z",
7884 "name": "Engineering",
85 "role_ids": [
86 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
87 ],
7988 "roles": [
8089 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
8190 ],
api/beta/organization/rbac_groups/update Changed · +13 / -4 lines
from line 5
55
66# Update RBAC Group
77
8**POST** `/v1/organizations/rbac_groups/{group_id}`
8**POST** `/v1/organizations/rbac_groups/{rbac_group_id}`
99
1010Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
1111
from line 13
1313
1414## Path parameters
1515
16- `group_id: string`
16- `rbac_group_id: string`
1717
1818 ID of the RBAC Group.
1919
from line 51
5151
5252 Name of the RBAC Group. Not uniqueness-enforced.
5353
54 - `roles: array of string or null`
54 - `role_ids: array of string or null`
5555
5656 RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
5757
from line 69
6969
7070 format: date-time
7171
72 - `roles: array of string or null`
73
74 **Deprecated**: Use `role_ids` instead; `roles` always has the same value.
75
76 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
77
7278## Example
7379
7480```bash
75curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
81curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
7682 -H 'Content-Type: application/json' \
7783 -H 'anthropic-version: 2023-06-01' \
7884 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
from line 94
8894 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
8995 "created_at": "2024-10-30T23:58:27.427722Z",
9096 "name": "Engineering",
97 "role_ids": [
98 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
99 ],
91100 "roles": [
92101 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
93102 ],
api/beta/organization/rbac_roles Changed · +6 / -6 lines
from line 96
9696
9797## Get RBAC Role
9898
99**GET** `/v1/organizations/rbac_roles/{role_id}`
99**GET** `/v1/organizations/rbac_roles/{rbac_role_id}`
100100
101101Retrieve an RBAC Role by ID.
102102
from line 104
104104
105105### Path parameters
106106
107- `role_id: string`
107- `rbac_role_id: string`
108108
109109 ID of the RBAC Role.
110110
from line 143
143143### Example
144144
145145```bash
146curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \
146curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID \
147147 -H 'anthropic-version: 2023-06-01' \
148148 -H "X-Api-Key: $ANTHROPIC_API_KEY"
149149```
from line 198
198198
199199### List RBAC Role Permissions
200200
201**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`
201**GET** `/v1/organizations/rbac_roles/{rbac_role_id}/permissions`
202202
203203List the permissions an RBAC Role grants.
204204
from line 206
206206
207207#### Path parameters
208208
209- `role_id: string`
209- `rbac_role_id: string`
210210
211211 ID of the RBAC Role.
212212
from line 349
349349#### Example
350350
351351```bash
352curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
352curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID/permissions \
353353 -H 'anthropic-version: 2023-06-01' \
354354 -H "X-Api-Key: $ANTHROPIC_API_KEY"
355355```
api/beta/organization/rbac_roles/permissions Changed · +3 / -3 lines
from line 7
77
88## List RBAC Role Permissions
99
10**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`
10**GET** `/v1/organizations/rbac_roles/{rbac_role_id}/permissions`
1111
1212List the permissions an RBAC Role grants.
1313
from line 15
1515
1616### Path parameters
1717
18- `role_id: string`
18- `rbac_role_id: string`
1919
2020 ID of the RBAC Role.
2121
from line 158
158158### Example
159159
160160```bash
161curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
161curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID/permissions \
162162 -H 'anthropic-version: 2023-06-01' \
163163 -H "X-Api-Key: $ANTHROPIC_API_KEY"
164164```
api/beta/organization/rbac_roles/permissions/list Changed · +3 / -3 lines
from line 5
55
66# List RBAC Role Permissions
77
8**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`
8**GET** `/v1/organizations/rbac_roles/{rbac_role_id}/permissions`
99
1010List the permissions an RBAC Role grants.
1111
from line 13
1313
1414## Path parameters
1515
16- `role_id: string`
16- `rbac_role_id: string`
1717
1818 ID of the RBAC Role.
1919
from line 156
156156## Example
157157
158158```bash
159curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
159curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID/permissions \
160160 -H 'anthropic-version: 2023-06-01' \
161161 -H "X-Api-Key: $ANTHROPIC_API_KEY"
162162```
api/beta/organization/rbac_roles/retrieve Changed · +3 / -3 lines
from line 5
55
66# Get RBAC Role
77
8**GET** `/v1/organizations/rbac_roles/{role_id}`
8**GET** `/v1/organizations/rbac_roles/{rbac_role_id}`
99
1010Retrieve an RBAC Role by ID.
1111
from line 13
1313
1414## Path parameters
1515
16- `role_id: string`
16- `rbac_role_id: string`
1717
1818 ID of the RBAC Role.
1919
from line 52
5252## Example
5353
5454```bash
55curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \
55curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID \
5656 -H 'anthropic-version: 2023-06-01' \
5757 -H "X-Api-Key: $ANTHROPIC_API_KEY"
5858```
api/beta/organization/workspaces Changed · +116 / -29 lines
from line 1280
12801280
12811281 default: workspace_rate_limit
12821282
1283 - `group_type: "batch" or "files" or "model_group" or 3 more`
1283 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
12841284
1285 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
1285 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
12861286
1287 - `"batch"`
1287 - `BetaOrganizationRateLimitModelGroup object`
12881288
1289 - `"files"`
1289 - `type: "model_group"`
12901290
1291 - `"model_group"`
1291 Always `model_group`: a family of models.
12921292
1293 - `"skills"`
1293 default: model_group
12941294
1295 - `"token_count"`
1295 - `id: string`
12961296
1297 - `"web_search"`
1297 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
12981298
1299 - `display_name: string`
1300
1301 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
1302
1303 - `BetaOrganizationRateLimitBatchGroup object`
1304
1305 - `type: "batch"`
1306
1307 Always `batch`: the Message Batches API.
1308
1309 default: batch
1310
1311 - `id: string`
1312
1313 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
1314
1315 - `BetaOrganizationRateLimitTokenCountGroup object`
1316
1317 - `type: "token_count"`
1318
1319 Always `token_count`: the Token Count API.
1320
1321 default: token_count
1322
1323 - `id: string`
1324
1325 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
1326
1327 - `BetaOrganizationRateLimitFilesGroup object`
1328
1329 - `type: "files"`
1330
1331 Always `files`: the Files API.
1332
1333 default: files
1334
1335 - `id: string`
1336
1337 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
1338
1339 - `BetaOrganizationRateLimitSkillsGroup object`
1340
1341 - `type: "skills"`
1342
1343 Always `skills`: the Skills API.
1344
1345 default: skills
1346
1347 - `id: string`
1348
1349 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
1350
1351 - `BetaOrganizationRateLimitWebSearchGroup object`
1352
1353 - `type: "web_search"`
1354
1355 Always `web_search`: the Messages API web search tool.
1356
1357 default: web_search
1358
1359 - `id: string`
1360
1361 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
1362
12991363 - `limits: array of BetaWorkspaceRateLimitValue`
13001364
13011365 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
from line 1382
13181382
13191383 - `rate_limit_id: string`
13201384
1321 The `id` of the RateLimit group this override applies to.
1385 The `id` of the organization's RateLimit entry this override applies to.
13221386
13231387 - `workspace_id: string`
13241388
13251389 ID of the Workspace this override applies to.
13261390
1391 - `group_type: "batch" or "files" or "model_group" or 3 more`
1392
1393 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
1394
1395 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
1396
1397 - `"batch"`
1398
1399 - `"files"`
1400
1401 - `"model_group"`
1402
1403 - `"skills"`
1404
1405 - `"token_count"`
1406
1407 - `"web_search"`
1408
13271409- `next_page: string or null`
13281410
13291411 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
from line 1424
13421424{
13431425 "data": [
13441426 {
1427 "group": {
1428 "id": "id",
1429 "display_name": "display_name",
1430 "type": "model_group"
1431 },
13451432 "group_type": "batch",
13461433 "limits": [
13471434 {
api/beta/organization/workspaces/rate_limits Changed · +227 / -58 lines
from line 67
6767
6868 default: workspace_rate_limit
6969
70 - `group_type: "batch" or "files" or "model_group" or 3 more`
70 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
7171
72 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
72 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
7373
74 - `"batch"`
74 - `BetaOrganizationRateLimitModelGroup object`
7575
76 - `"files"`
76 - `type: "model_group"`
7777
78 - `"model_group"`
78 Always `model_group`: a family of models.
7979
80 - `"skills"`
80 default: model_group
8181
82 - `"token_count"`
82 - `id: string`
8383
84 - `"web_search"`
84 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
8585
86 - `display_name: string`
87
88 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
89
90 - `BetaOrganizationRateLimitBatchGroup object`
91
92 - `type: "batch"`
93
94 Always `batch`: the Message Batches API.
95
96 default: batch
97
98 - `id: string`
99
100 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
101
102 - `BetaOrganizationRateLimitTokenCountGroup object`
103
104 - `type: "token_count"`
105
106 Always `token_count`: the Token Count API.
107
108 default: token_count
109
110 - `id: string`
111
112 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
113
114 - `BetaOrganizationRateLimitFilesGroup object`
115
116 - `type: "files"`
117
118 Always `files`: the Files API.
119
120 default: files
121
122 - `id: string`
123
124 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
125
126 - `BetaOrganizationRateLimitSkillsGroup object`
127
128 - `type: "skills"`
129
130 Always `skills`: the Skills API.
131
132 default: skills
133
134 - `id: string`
135
136 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
137
138 - `BetaOrganizationRateLimitWebSearchGroup object`
139
140 - `type: "web_search"`
141
142 Always `web_search`: the Messages API web search tool.
143
144 default: web_search
145
146 - `id: string`
147
148 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
149
86150 - `limits: array of BetaWorkspaceRateLimitValue`
87151
88152 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
from line 169
105169
106170 - `rate_limit_id: string`
107171
108 The `id` of the RateLimit group this override applies to.
172 The `id` of the organization's RateLimit entry this override applies to.
109173
110174 - `workspace_id: string`
111175
112176 ID of the Workspace this override applies to.
113177
178 - `group_type: "batch" or "files" or "model_group" or 3 more`
179
180 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
181
182 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
183
184 - `"batch"`
185
186 - `"files"`
187
188 - `"model_group"`
189
190 - `"skills"`
191
192 - `"token_count"`
193
194 - `"web_search"`
195
114196- `next_page: string or null`
115197
116198 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
from line 211
129211{
130212 "data": [
131213 {
214 "group": {
215 "id": "id",
216 "display_name": "display_name",
217 "type": "model_group"
218 },
132219 "group_type": "batch",
133220 "limits": [
134221 {
from line 248
161248
162249 default: workspace_rate_limit
163250
164 - `group_type: "batch" or "files" or "model_group" or 3 more`
251 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
165252
166 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
253 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
167254
168 - `"batch"`
255 - `BetaOrganizationRateLimitModelGroup object`
169256
170 - `"files"`
257 - `type: "model_group"`
171258
172 - `"model_group"`
259 Always `model_group`: a family of models.
173260
174 - `"skills"`
261 default: model_group
175262
176 - `"token_count"`
263 - `id: string`
177264
178 - `"web_search"`
265 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
179266
267 - `display_name: string`
268
269 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
270
271 - `BetaOrganizationRateLimitBatchGroup object`
272
273 - `type: "batch"`
274
275 Always `batch`: the Message Batches API.
276
277 default: batch
278
279 - `id: string`
280
281 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
282
283 - `BetaOrganizationRateLimitTokenCountGroup object`
284
285 - `type: "token_count"`
286
287 Always `token_count`: the Token Count API.
288
289 default: token_count
290
291 - `id: string`
292
293 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
294
295 - `BetaOrganizationRateLimitFilesGroup object`
296
297 - `type: "files"`
298
299 Always `files`: the Files API.
300
301 default: files
302
303 - `id: string`
304
305 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
306
307 - `BetaOrganizationRateLimitSkillsGroup object`
308
309 - `type: "skills"`
310
311 Always `skills`: the Skills API.
312
313 default: skills
314
315 - `id: string`
316
317 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
318
319 - `BetaOrganizationRateLimitWebSearchGroup object`
320
321 - `type: "web_search"`
322
323 Always `web_search`: the Messages API web search tool.
324
325 default: web_search
326
327 - `id: string`
328
329 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
330
180331 - `limits: array of BetaWorkspaceRateLimitValue`
181332
182333 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
from line 350
199350
200351 - `rate_limit_id: string`
201352
202 The `id` of the RateLimit group this override applies to.
353 The `id` of the organization's RateLimit entry this override applies to.
203354
204355 - `workspace_id: string`
205356
206357 ID of the Workspace this override applies to.
358
359 - `group_type: "batch" or "files" or "model_group" or 3 more`
360
361 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
362
363 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
364
365 - `"batch"`
366
367 - `"files"`
368
369 - `"model_group"`
370
371 - `"skills"`
372
373 - `"token_count"`
374
375 - `"web_search"`
207376
208377### Beta Workspace Rate Limit Value
209378
api/beta/organization/workspaces/rate_limits/list Changed · +116 / -29 lines
from line 65
6565
6666 default: workspace_rate_limit
6767
68 - `group_type: "batch" or "files" or "model_group" or 3 more`
68 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`
6969
70 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
70 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
7171
72 - `"batch"`
72 - `BetaOrganizationRateLimitModelGroup object`
7373
74 - `"files"`
74 - `type: "model_group"`
7575
76 - `"model_group"`
76 Always `model_group`: a family of models.
7777
78 - `"skills"`
78 default: model_group
7979
80 - `"token_count"`
80 - `id: string`
8181
82 - `"web_search"`
82 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
8383
84 - `display_name: string`
85
86 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
87
88 - `BetaOrganizationRateLimitBatchGroup object`
89
90 - `type: "batch"`
91
92 Always `batch`: the Message Batches API.
93
94 default: batch
95
96 - `id: string`
97
98 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
99
100 - `BetaOrganizationRateLimitTokenCountGroup object`
101
102 - `type: "token_count"`
103
104 Always `token_count`: the Token Count API.
105
106 default: token_count
107
108 - `id: string`
109
110 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
111
112 - `BetaOrganizationRateLimitFilesGroup object`
113
114 - `type: "files"`
115
116 Always `files`: the Files API.
117
118 default: files
119
120 - `id: string`
121
122 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
123
124 - `BetaOrganizationRateLimitSkillsGroup object`
125
126 - `type: "skills"`
127
128 Always `skills`: the Skills API.
129
130 default: skills
131
132 - `id: string`
133
134 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
135
136 - `BetaOrganizationRateLimitWebSearchGroup object`
137
138 - `type: "web_search"`
139
140 Always `web_search`: the Messages API web search tool.
141
142 default: web_search
143
144 - `id: string`
145
146 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
147
84148 - `limits: array of BetaWorkspaceRateLimitValue`
85149
86150 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
from line 167
103167
104168 - `rate_limit_id: string`
105169
106 The `id` of the RateLimit group this override applies to.
170 The `id` of the organization's RateLimit entry this override applies to.
107171
108172 - `workspace_id: string`
109173
110174 ID of the Workspace this override applies to.
111175
176 - `group_type: "batch" or "files" or "model_group" or 3 more`
177
178 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
179
180 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
181
182 - `"batch"`
183
184 - `"files"`
185
186 - `"model_group"`
187
188 - `"skills"`
189
190 - `"token_count"`
191
192 - `"web_search"`
193
112194- `next_page: string or null`
113195
114196 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
from line 209
127209{
128210 "data": [
129211 {
212 "group": {
213 "id": "id",
214 "display_name": "display_name",
215 "type": "model_group"
216 },
130217 "group_type": "batch",
131218 "limits": [
132219 {
api/beta/sessions Changed · +155 / -9 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 115
115115
116116- `"anthropic-workspace-id": optional string`
117117
118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
119
120 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121
118122### Body parameters
119123
120124- `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams`
from line 269
265269
266270 - `"low"`
267271
272 Low effort. Favors latency over reasoning depth.
273
268274 - `"medium"`
269275
276 Medium effort. Balances latency and reasoning depth.
277
270278 - `"high"`
271279
280 High effort. Favors reasoning depth.
281
272282 - `"xhigh"`
273283
284 Extra-high effort. Not all models accept this level.
285
274286 - `"max"`
275287
288 Maximum effort. Favors reasoning depth over latency.
289
276290 - `BetaManagedAgentsEffortLow object`
277291
278292 Low effort. Favors latency over reasoning depth.
from line 1943
19291943
19301944 - `"rescheduling"`
19311945
1946 Transient error occurred, retrying automatically.
1947
19321948 - `"running"`
19331949
1950 Agent is actively executing.
1951
19341952 - `"idle"`
19351953
1954 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
1955
19361956 - `"terminated"`
19371957
1958 Session has ended, either due to an error or completion.
1959
19381960 - `title: string or null`
19391961
19401962 - `updated_at: string`
from line 2324
23022324
23032325 - `"rescheduling"`
23042326
2327 Transient error occurred, retrying automatically.
2328
23052329 - `"running"`
23062330
2331 Agent is actively executing.
2332
23072333 - `"idle"`
23082334
2335 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
2336
23092337 - `"terminated"`
23102338
2339 Session has ended, either due to an error or completion.
2340
23112341### Headers
23122342
23132343- `"anthropic-beta": optional array of AnthropicBeta`
from line 2442
24122442
24132443- `"anthropic-workspace-id": optional string`
24142444
2445 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
2446
2447 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
2448
24152449### Returns
24162450
24172451- `data: optional array of BetaManagedAgentsSession`
from line 3244
32103244
32113245 - `"rescheduling"`
32123246
3247 Transient error occurred, retrying automatically.
3248
32133249 - `"running"`
32143250
3251 Agent is actively executing.
3252
32153253 - `"idle"`
32163254
3255 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
3256
32173257 - `"terminated"`
32183258
3259 Session has ended, either due to an error or completion.
3260
32193261 - `title: string or null`
32203262
32213263 - `updated_at: string`
from line 3669
36273669
36283670- `"anthropic-workspace-id": optional string`
36293671
3672 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
3673
3674 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
3675
36303676### Returns
36313677
36323678- `BetaManagedAgentsSession object`
from line 4471
44254471
44264472 - `"rescheduling"`
44274473
4474 Transient error occurred, retrying automatically.
4475
44284476 - `"running"`
44294477
4478 Agent is actively executing.
4479
44304480 - `"idle"`
44314481
4482 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
4483
44324484 - `"terminated"`
44334485
4486 Session has ended, either due to an error or completion.
4487
44344488 - `title: string or null`
44354489
44364490 - `updated_at: string`
from line 4882
48284882
48294883- `"anthropic-workspace-id": optional string`
48304884
4885 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
4886
4887 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
4888
48314889### Body parameters
48324890
48334891- `agent: optional BetaManagedAgentsSessionAgentUpdate`
from line 6170
61126170
61136171 - `"rescheduling"`
61146172
6173 Transient error occurred, retrying automatically.
6174
61156175 - `"running"`
61166176
6177 Agent is actively executing.
6178
61176179 - `"idle"`
61186180
6181 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
6182
61196183 - `"terminated"`
61206184
6185 Session has ended, either due to an error or completion.
6186
61216187 - `title: string or null`
61226188
61236189 - `updated_at: string`
from line 6585
65196585
65206586- `"anthropic-workspace-id": optional string`
65216587
6588 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
6589
6590 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
6591
65226592### Returns
65236593
65246594- `BetaManagedAgentsDeletedSession object`
from line 6732
66626732
66636733- `"anthropic-workspace-id": optional string`
66646734
6735 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
6736
6737 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
6738
66656739### Returns
66666740
66676741- `BetaManagedAgentsSession object`
from line 7534
74607534
74617535 - `"rescheduling"`
74627536
7537 Transient error occurred, retrying automatically.
7538
74637539 - `"running"`
74647540
7541 Agent is actively executing.
7542
74657543 - `"idle"`
74667544
7545 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
7546
74677547 - `"terminated"`
74687548
7549 Session has ended, either due to an error or completion.
7550
74697551 - `title: string or null`
74707552
74717553 - `updated_at: string`
from line 8014
79328014
79338015 - `"low"`
79348016
8017 Low effort. Favors latency over reasoning depth.
8018
79358019 - `"medium"`
79368020
8021 Medium effort. Balances latency and reasoning depth.
8022
79378023 - `"high"`
79388024
8025 High effort. Favors reasoning depth.
8026
79398027 - `"xhigh"`
79408028
8029 Extra-high effort. Not all models accept this level.
8030
79418031 - `"max"`
79428032
8033 Maximum effort. Favors reasoning depth over latency.
8034
79438035 - `BetaManagedAgentsEffortLow object`
79448036
79458037 Low effort. Favors latency over reasoning depth.
from line 8436
83448436
83458437 Default configuration for all tools in a toolset.
83468438
8347 - `enabled: optional boolean or null`
8348
8349 Whether tools are enabled and available to Claude by default. Defaults to true if not specified.
8350
8351 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
8352
8353 Permission policy for tool execution.
8354
8355 - `BetaManagedAgentsAlwaysAllowPolicy object`
8356
8357 Tool calls are automatically approved without user confirmation.
8358
8359 - `BetaManagedAgentsAlwaysAskPolicy object`
8360
8361 Tool calls require user confirmation before execution.
8362
8363 - `BetaManagedAgentsAutoPolicy object`
8364
8365 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
8366
8367 - `BetaManagedAgentsMCPToolsetParams object`
8368
8369 Configuration for tools from an MCP server defined in `mcp_servers`.
8370
8371 - `type: "mcp_toolset"`
8372
8373 - `mcp_server_name: string`
8374
8375 Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.
8376
8377 minLength: 1, maxLength: 255
8378
8379 - `configs: optional array of BetaManagedAgentsMCPToolConfigParams`
8380
8381 Per-tool configuration overrides.
8382
8383 - `name: string`
8384
8385 Name of the MCP tool to configure. 1-128 characters.
8386
8387 minLength: 1, maxLength: 128
8388
8389 - `enabled: optional boolean or null`
8390
8391 Whether this tool is enabled. Overrides the `default_config` setting.
8392
8393 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
8394
8395 Permission policy for tool execution.
8396
8397 - `BetaManagedAgentsAlwaysAllowPolicy object`
8398
8399 Tool calls are automatically approved without user confirmation.
8400
8401 - `BetaManagedAgentsAlwaysAskPolicy object`
8402
8403 Tool calls require user confirmation before execution.
8404
8405 - `BetaManagedAgentsAutoPolicy object`
8406
8407 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
8408
8409 - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null`
8410
8411 Default configuration for all tools from an MCP server.
8412
8413 - `enabled: optional boolean or null`
8414
8415 Whether tools are enabled by default. Defaults to true if not specified.
8416
8417 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
8418
8419 Permission policy for tool execution.
8420
8421 - `BetaManagedAgentsAlwaysAllowPolicy object`
8422
8423 Tool calls are automatically approved without user confirmation.
8424
8425 - `BetaManagedAgentsAlwaysAskPolicy object`
8426
8427 Tool calls require user confirmation before execution.
8428
8429 - `BetaManagedAgentsAutoPolicy object`
8430
8431 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
8432
8433 - `BetaManagedAgentsCustomToolParams object`
8434
8435 A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event.
8436
8437 - `type: "custom"`
8438
8439 - `description: string`
8440
8441 Description of what the tool does, shown to the agent to hel
8439
api/beta/sessions/archive Changed · +12 / -0 lines
from line 117
117117
118118- `"anthropic-workspace-id": optional string`
119119
120 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
121
122 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
123
120124## Returns
121125
122126- `BetaManagedAgentsSession object`
from line 919
915919
916920 - `"rescheduling"`
917921
922 Transient error occurred, retrying automatically.
923
918924 - `"running"`
919925
926 Agent is actively executing.
927
920928 - `"idle"`
921929
930 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
931
922932 - `"terminated"`
933
934 Session has ended, either due to an error or completion.
923935
924936 - `title: string or null`
925937
api/beta/sessions/create Changed · +22 / -0 lines
from line 113
113113
114114- `"anthropic-workspace-id": optional string`
115115
116 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
117
118 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
119
116120## Body parameters
117121
118122- `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams`
from line 267
263267
264268 - `"low"`
265269
270 Low effort. Favors latency over reasoning depth.
271
266272 - `"medium"`
267273
274 Medium effort. Balances latency and reasoning depth.
275
268276 - `"high"`
269277
278 High effort. Favors reasoning depth.
279
270280 - `"xhigh"`
271281
282 Extra-high effort. Not all models accept this level.
283
272284 - `"max"`
273285
286 Maximum effort. Favors reasoning depth over latency.
287
274288 - `BetaManagedAgentsEffortLow object`
275289
276290 Low effort. Favors latency over reasoning depth.
from line 1941
19271941
19281942 - `"rescheduling"`
19291943
1944 Transient error occurred, retrying automatically.
1945
19301946 - `"running"`
19311947
1948 Agent is actively executing.
1949
19321950 - `"idle"`
19331951
1952 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
1953
19341954 - `"terminated"`
1955
1956 Session has ended, either due to an error or completion.
19351957
19361958 - `title: string or null`
19371959
api/beta/sessions/events Changed · +12 / -2 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 43
4343
4444- `limit: optional number`
4545
46 Query parameter for limit
47
4846 format: int32
4947
5048- `order: optional "asc" or "desc"`
from line 165
167165
168166- `"anthropic-workspace-id": optional string`
169167
168 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
169
170 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
171
170172### Returns
171173
172174- `data: optional array of BetaManagedAgentsSessionEvent`
from line 2560
25582560
25592561- `"anthropic-workspace-id": optional string`
25602562
2563 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
2564
2565 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
2566
25612567### Body parameters
25622568
25632569- `events: array of BetaManagedAgentsEventParams`
from line 3541
35353541
35363542- `"anthropic-workspace-id": optional string`
35373543
3544 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
3545
3546 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
3547
35383548### Returns
35393549
35403550- `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more`
from line 8995
89858995 - `BetaManagedAgentsUserToolConfirmationEvent object`
89868996
89878997 A tool confirmation event that approves or denies a pending tool execution.
8988
8989 - `type: "user.tool_confirmation"`
8990
8991 - `id: string`
8992
8993 Unique identifier for this event.
8994
8995 - `result: "allow" or "deny"`
8996
8997 UserToolConfirmationResult enum
8998
8999 - `"allow"`
9000
9001 - `"deny"`
9002
9003 - `tool_use_id: string`
9004
9005 The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
9006
9007 - `deny_message: optional string or null`
9008
9009 Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.
9010
9011 maxLength: 10000
9012
9013 - `processed_at: optional string or null`
9014
9015 A timestamp in RFC 3339 format
9016
9017 format: date-time
9018
9019 - `session_thread_id: optional string or null`
9020
9021 Set by the serve
api/beta/sessions/events/list Changed · +4 / -2 lines
from line 41
4141
4242- `limit: optional number`
4343
44 Query parameter for limit
45
4644 format: int32
4745
4846- `order: optional "asc" or "desc"`
from line 162
164162 - `"compact-2026-09-04"`
165163
166164- `"anthropic-workspace-id": optional string`
165
166 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
167
168 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
167169
168170## Returns
169171
api/beta/sessions/list Changed · +20 / -0 lines
from line 81
8181
8282 - `"rescheduling"`
8383
84 Transient error occurred, retrying automatically.
85
8486 - `"running"`
8587
88 Agent is actively executing.
89
8690 - `"idle"`
8791
92 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
93
8894 - `"terminated"`
8995
96 Session has ended, either due to an error or completion.
97
9098## Headers
9199
92100- `"anthropic-beta": optional array of AnthropicBeta`
from line 199
191199
192200- `"anthropic-workspace-id": optional string`
193201
202 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
203
204 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
205
194206## Returns
195207
196208- `data: optional array of BetaManagedAgentsSession`
from line 1001
9891001
9901002 - `"rescheduling"`
9911003
1004 Transient error occurred, retrying automatically.
1005
9921006 - `"running"`
9931007
1008 Agent is actively executing.
1009
9941010 - `"idle"`
9951011
1012 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
1013
9961014 - `"terminated"`
1015
1016 Session has ended, either due to an error or completion.
9971017
9981018 - `title: string or null`
9991019