from line 1
1---
2title: RBAC Groups
3url: https://platform.claude.com/docs/en/api/admin/rbac_groups
4---
5
61# RBAC Groups
72
83## List RBAC Groups
94
10**get** `/v1/organizations/rbac_groups`
5**GET** `/v1/organizations/rbac_groups`
116
127List RBAC Groups in the Claude Enterprise tenant.
138
149The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
1510
16### Query Parameters
11### Query parameters
1712
1813- `limit: optional number`
1914
from line 16
2116
2217 Defaults to `20`. Ranges from `1` to `1000`.
2318
19 default: 20, maximum: 1000, minimum: 1
20
2421- `page: optional string`
2522
2623 Optionally set to the `next_page` token from the previous response.
2724
28### Header Parameters
25### Headers
2926
3027- `"anthropic-beta": optional array of string`
3128
from line 42
4542
4643 RFC 3339 timestamp of when the RBAC Group was created.
4744
45 format: date-time
46
4847 - `name: string`
4948
5049 Name of the RBAC Group. Not uniqueness-enforced.
from line 66
6766
6867 For RBAC Groups, this is always `"rbac_group"`.
6968
70 - `"rbac_group"`
69 default: rbac_group
7170
7271 - `updated_at: string`
7372
7473 RFC 3339 timestamp of when the RBAC Group was last updated.
7574
75 format: date-time
76
7677- `has_more: boolean`
7778
7879 Indicates if there are more results in the requested page direction.
from line 84
8384
8485### Example
8586
86```http
87```bash
8788curl https://api.anthropic.com/v1/organizations/rbac_groups \
8889 -H 'anthropic-version: 2023-06-01' \
8990 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
9091```
9192
92#### Response
93#### Response (200)
9394
9495```json
9596{
from line 114
113114
114115## Get RBAC Group
115116
116**get** `/v1/organizations/rbac_groups/{group_id}`
117**GET** `/v1/organizations/rbac_groups/{group_id}`
117118
118119Retrieve an RBAC Group by ID.
119120
120121The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
121122
122### Path Parameters
123### Path parameters
123124
124125- `group_id: string`
125126
126127 ID of the RBAC Group.
127128
128### Header Parameters
129### Headers
129130
130131- `"anthropic-beta": optional array of string`
131132
from line 136
135136
136137### Returns
137138
138- `RbacGroup object { id, created_at, name, 4 more }`
139- `RbacGroup object`
139140
140141 - `id: string`
141142
from line 146
145146
146147 RFC 3339 timestamp of when the RBAC Group was created.
147148
149 format: date-time
150
148151 - `name: string`
149152
150153 Name of the RBAC Group. Not uniqueness-enforced.
from line 170
167170
168171 For RBAC Groups, this is always `"rbac_group"`.
169172
170 - `"rbac_group"`
173 default: rbac_group
171174
172175 - `updated_at: string`
173176
174177 RFC 3339 timestamp of when the RBAC Group was last updated.
175178
179 format: date-time
180
176181### Example
177182
178```http
183```bash
179184curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
180185 -H 'anthropic-version: 2023-06-01' \
181186 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
182187```
183188
184#### Response
189#### Response (200)
185190
186191```json
187192{
from line 204
199204
200205## Create RBAC Group
201206
202**post** `/v1/organizations/rbac_groups`
207**POST** `/v1/organizations/rbac_groups`
203208
204209Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`.
205210
206211The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
207212
208### Header Parameters
213### Headers
209214
210215- `"anthropic-beta": optional array of string`
211216
from line 218
213218
214219 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
215220
216### Body Parameters
221### Body parameters
217222
218223- `name: string`
219224
220225 Name of the RBAC Group. Not uniqueness-enforced.
221226
227 maxLength: 255, minLength: 1
228
222229### Returns
223230
224- `RbacGroup object { id, created_at, name, 4 more }`
231- `RbacGroup object`
225232
226233 - `id: string`
227234
from line 238
231238
232239 RFC 3339 timestamp of when the RBAC Group was created.
233240
241 format: date-time
242
234243 - `name: string`
235244
236245 Name of the RBAC Group. Not uniqueness-enforced.
from line 262
253262
254263 For RBAC Groups, this is always `"rbac_group"`.
255264
256 - `"rbac_group"`
265 default: rbac_group
257266
258267 - `updated_at: string`
259268
260269 RFC 3339 timestamp of when the RBAC Group was last updated.
261270
271 format: date-time
272
262273### Example
263274
264```http
275```bash
265276curl https://api.anthropic.com/v1/organizations/rbac_groups \
266277 -H 'Content-Type: application/json' \
267278 -H 'anthropic-version: 2023-06-01' \
from line 282
271282 }'
272283```
273284
274#### Response
285#### Response (200)
275286
276287```json
277288{
from line 300
289300
290301## Update RBAC Group
291302
292**post** `/v1/organizations/rbac_groups/{group_id}`
303**POST** `/v1/organizations/rbac_groups/{group_id}`
293304
294305Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
295306
296307The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
297308
298### Path Parameters
309### Path parameters
299310
300311- `group_id: string`
301312
302313 ID of the RBAC Group.
303314
304### Header Parameters
315### Headers
305316
306317- `"anthropic-beta": optional array of string`
307318
from line 320
309320
310321 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
311322
312### Body Parameters
323### Body parameters
313324
314325- `name: optional string or null`
315326
316327 Name of the RBAC Group. Not uniqueness-enforced.
317328
329 maxLength: 255, minLength: 1
330
318331### Returns
319332
320- `RbacGroup object { id, created_at, name, 4 more }`
333- `RbacGroup object`
321334
322335 - `id: string`
323336
from line 340
327340
328341 RFC 3339 timestamp of when the RBAC Group was created.
329342
343 format: date-time
344
330345 - `name: string`
331346
332347 Name of the RBAC Group. Not uniqueness-enforced.
from line 364
349364
350365 For RBAC Groups, this is always `"rbac_group"`.
351366
352 - `"rbac_group"`
367 default: rbac_group
353368
354369 - `updated_at: string`
355370
356371 RFC 3339 timestamp of when the RBAC Group was last updated.
357372
373 format: date-time
374
358375### Example
359376
360```http
377```bash
361378curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
362379 -H 'Content-Type: application/json' \
363380 -H 'anthropic-version: 2023-06-01' \
from line 384
367384 }'
368385```
369386
370#### Response
387#### Response (200)
371388
372389```json
373390{
from line 402
385402
386403## Delete RBAC Group
387404
388**delete** `/v1/organizations/rbac_groups/{group_id}`
405**DELETE** `/v1/organizations/rbac_groups/{group_id}`
389406
390407Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API.
391408
392409The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
393410
394### Path Parameters
411### Path parameters
395412
396413- `group_id: string`
397414
398415 ID of the RBAC Group.
399416
400### Header Parameters
417### Headers
401418
402419- `"anthropic-beta": optional array of string`
403420
from line 424
407424
408425### Returns
409426
410- `RbacGroupDeleted object { id, type }`
427- `RbacGroupDeleted object`
411428
412429 - `id: string`
413430
from line 436
419436
420437 For RBAC Groups, this is always `"rbac_group_deleted"`.
421438
422 - `"rbac_group_deleted"`
439 default: rbac_group_deleted
423440
424441### Example
425442
426```http
443```bash
427444curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
428445 -X DELETE \
429446 -H 'anthropic-version: 2023-06-01' \
from line 447
430447 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
431448```
432449
433#### Response
450#### Response (200)
434451
435452```json
436453{
from line 456
439456}
440457```
441458
442## Domain Types
459## Domain types
443460
444461### Rbac Group
445462
446- `RbacGroup object { id, created_at, name, 4 more }`
463- `RbacGroup object`
447464
448465 - `id: string`
449466
from line 470
453470
454471 RFC 3339 timestamp of when the RBAC Group was created.
455472
473 format: date-time
474
456475 - `name: string`
457476
458477 Name of the RBAC Group. Not uniqueness-enforced.
from line 494
475494
476495 For RBAC Groups, this is always `"rbac_group"`.
477496
478 - `"rbac_group"`
497 default: rbac_group
479498
480499 - `updated_at: string`
481500
482501 RFC 3339 timestamp of when the RBAC Group was last updated.
483502
503 format: date-time
504
484505### Rbac Group Deleted
485506
486- `RbacGroupDeleted object { id, type }`
507- `RbacGroupDeleted object`
487508
488509 - `id: string`
489510
from line 516
495516
496517 For RBAC Groups, this is always `"rbac_group_deleted"`.
497518
498 - `"rbac_group_deleted"`
519 default: rbac_group_deleted
499520
500# Members
521## RBAC Groups › Members
501522
502## List RBAC Group Members
523### List RBAC Group Members
503524
504**get** `/v1/organizations/rbac_groups/{group_id}/members`
525**GET** `/v1/organizations/rbac_groups/{group_id}/members`
505526
506527List members of an RBAC Group.
507528
508529The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
509530
510### Path Parameters
531#### Path parameters
511532
512533- `group_id: string`
513534
514535 ID of the RBAC Group.
515536
516### Query Parameters
537#### Query parameters
517538
518539- `limit: optional number`
519540
from line 542
521542
522543 Defaults to `20`. Ranges from `1` to `1000`.
523544
545 default: 20, maximum: 1000, minimum: 1
546
524547- `page: optional string`
525548
526549 Optionally set to the `next_page` token from the previous response.
527550
528### Header Parameters
551#### Headers
529552
530553- `"anthropic-beta": optional array of string`
531554
from line 556
533556
534557 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
535558
536### Returns
559#### Returns
537560
538561- `data: array of RbacGroupMember`
539562
from line 564
541564
542565 RFC 3339 timestamp of when the User was added to the RBAC Group.
543566
567 format: date-time
568
544569 - `email: string`
545570
546571 Email of the User.
from line 580
555580
556581 For RBAC Group Members, this is always `"rbac_group_member"`.
557582
558 - `"rbac_group_member"`
583 default: rbac_group_member
559584
560585 - `user_id: string`
561586
from line 594
569594
570595 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
571596
572### Example
597#### Example
573598
574```http
599```bash
575600curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
576601 -H 'anthropic-version: 2023-06-01' \
577602 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
578603```
579604
580#### Response
605##### Response (200)
581606
582607```json
583608{
from line 620
595620}
596621```
597622
598## Add RBAC Group Member
623### Add RBAC Group Member
599624
600**post** `/v1/organizations/rbac_groups/{group_id}/members`
625**POST** `/v1/organizations/rbac_groups/{group_id}/members`
601626
602627Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
603628
604629The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
605630
606### Path Parameters
631#### Path parameters
607632
608633- `group_id: string`
609634
610635 ID of the RBAC Group.
611636
612### Header Parameters
637#### Headers
613638
614639- `"anthropic-beta": optional array of string`
615640
from line 642
617642
618643 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
619644
620### Body Parameters
645#### Body parameters
621646
622647- `user_id: string`
623648
624649 ID of the User.
625650
626### Returns
651#### Returns
627652
628- `RbacGroupMember object { created_at, email, group_id, 2 more }`
653- `RbacGroupMember object`
629654
630655 - `created_at: string`
631656
632657 RFC 3339 timestamp of when the User was added to the RBAC Group.
633658
659 format: date-time
660
634661 - `email: string`
635662
636663 Email of the User.
from line 672
645672
646673 For RBAC Group Members, this is always `"rbac_group_member"`.
647674
648 - `"rbac_group_member"`
675 default: rbac_group_member
649676
650677 - `user_id: string`
651678
652679 ID of the User.
653680
654### Example
681#### Example
655682
656```http
683```bash
657684curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
658685 -H 'Content-Type: application/json' \
659686 -H 'anthropic-version: 2023-06-01' \
from line 690
663690 }'
664691```
665692
666#### Response
693##### Response (200)
667694
668695```json
669696{
from line 702
675702}
676703```
677704
678## Remove RBAC Group Member
705### Remove RBAC Group Member
679706
680**delete** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
707**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}`
681708
682709Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API.
683710
684711The RBAC Groups API is in beta and available to Claude Enterprise organizations only. Requests must send the `ce-user-management-2026-07-13` value in the `anthropic-beta` header.
685712
686### Path Parameters
713#### Path parameters
687714
688715- `group_id: string`
689716
from line 720
693720
694721 ID of the User.
695722
696### Header Parameters
723#### Headers
697724
698725- `"anthropic-beta": optional array of string`
699726
from line 728
701728
702729 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
703730
704### Returns
731#### Returns
705732
706- `RbacGroupMemberDeleted object { group_id, type, user_id }`
733- `RbacGroupMemberDeleted object`
707734
708735 - `group_id: string`
709736
from line 740
713740
714741 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
715742
716 - `"rbac_group_member_deleted"`
743 default: rbac_group_member_deleted
717744
718745 - `user_id: string`
719746
720747 ID of the User.
721748
722### Example
749#### Example
723750
724```http
751```bash
725752curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
726753 -X DELETE \
727754 -H 'anthropic-version: 2023-06-01' \
from line 755
728755 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
729756```
730757
731#### Response
758##### Response (200)
732759
733760```json
734761{
from line 764
737764 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
738765}
739766```
740
741## Domain Types
742
743### Rbac Group Member
744
745- `RbacGroupMember object { created_at, email, group_id, 2 more }`
746
747 - `created_at: string`
748
749 RFC 3339 timestamp of when the User was added to the RBAC Group.
750
751 - `email: string`
752
753 Email of the User.
754
755 - `group_id: string`
756
757 ID of the RBAC Group.
758
759 - `type: "rbac_group_member"`
760
761 Object type.
762
763 For RBAC Group Members, this is always `"rbac_group_member"`.
764
765 - `"rbac_group_member"`
766
767 - `user_id: string`
768
769 ID of the User.
770
771### Rbac Group Member Deleted
772
773- `RbacGroupMemberDeleted object { group_id, type, user_id }`
774
775 - `group_id: string`
776
777 ID of the RBAC Group.
778
779 - `type: "rbac_group_member_deleted"`
780
781 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
782
783 - `"rbac_group_member_deleted"`
784
785 - `user_id: string`
786
787 ID of the User.
788767
No line in this hunk matches that.