One change
RBAC Groups
api/admin/rbac_groups
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/rbac_groups Changed · +114 / -135 lines
### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## RBAC Groups › Members ### List RBAC Group Members #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Add RBAC Group Member #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### Remove RBAC Group Member #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Members ## List RBAC Group Members ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Add RBAC Group Member ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## Remove RBAC Group Member ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Rbac Group Member ### Rbac Group Member Deleted
from line 1
---- -title: RBAC Groups -url: https://platform.claude.com/docs/en/api/admin/rbac_groups ---- - # RBAC Groups ## List RBAC Groups -**get** `/v1/organizations/rbac_groups` +**GET** `/v1/organizations/rbac_groups` List RBAC Groups in the Claude Enterprise tenant. The 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. -### Query Parameters +### Query parameters - `limit: optional number`
from line 16
Defaults to `20`. Ranges from `1` to `1000`. + default: 20, maximum: 1000, minimum: 1 + - `page: optional string` Optionally set to the `next_page` token from the previous response. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
from line 42
RFC 3339 timestamp of when the RBAC Group was created. + format: date-time + - `name: string` Name of the RBAC Group. Not uniqueness-enforced.
from line 66
For RBAC Groups, this is always `"rbac_group"`. - - `"rbac_group"` + default: rbac_group - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. + format: date-time + - `has_more: boolean` Indicates if there are more results in the requested page direction.
from line 84
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
from line 114
## Get RBAC Group -**get** `/v1/organizations/rbac_groups/{group_id}` +**GET** `/v1/organizations/rbac_groups/{group_id}` Retrieve an RBAC Group by ID. The 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. -### Path Parameters +### Path parameters - `group_id: string` ID of the RBAC Group. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
from line 136
### Returns -- `RbacGroup object { id, created_at, name, 4 more }` +- `RbacGroup object` - `id: string`
from line 146
RFC 3339 timestamp of when the RBAC Group was created. + format: date-time + - `name: string` Name of the RBAC Group. Not uniqueness-enforced.
from line 170
For RBAC Groups, this is always `"rbac_group"`. - - `"rbac_group"` + default: rbac_group - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. + format: date-time + ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
from line 204
## Create RBAC Group -**post** `/v1/organizations/rbac_groups` +**POST** `/v1/organizations/rbac_groups` Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`. The 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. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
from line 218
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Body Parameters +### Body parameters - `name: string` Name of the RBAC Group. Not uniqueness-enforced. + maxLength: 255, minLength: 1 + ### Returns -- `RbacGroup object { id, created_at, name, 4 more }` +- `RbacGroup object` - `id: string`
from line 238
RFC 3339 timestamp of when the RBAC Group was created. + format: date-time + - `name: string` Name of the RBAC Group. Not uniqueness-enforced.
from line 262
For RBAC Groups, this is always `"rbac_group"`. - - `"rbac_group"` + default: rbac_group - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. + format: date-time + ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 282
}' ``` -#### Response +#### Response (200) ```json {
from line 300
## Update RBAC Group -**post** `/v1/organizations/rbac_groups/{group_id}` +**POST** `/v1/organizations/rbac_groups/{group_id}` Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API. The 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. -### Path Parameters +### Path parameters - `group_id: string` ID of the RBAC Group. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
from line 320
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Body Parameters +### Body parameters - `name: optional string or null` Name of the RBAC Group. Not uniqueness-enforced. + maxLength: 255, minLength: 1 + ### Returns -- `RbacGroup object { id, created_at, name, 4 more }` +- `RbacGroup object` - `id: string`
from line 340
RFC 3339 timestamp of when the RBAC Group was created. + format: date-time + - `name: string` Name of the RBAC Group. Not uniqueness-enforced.
from line 364
For RBAC Groups, this is always `"rbac_group"`. - - `"rbac_group"` + default: rbac_group - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. + format: date-time + ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 384
}' ``` -#### Response +#### Response (200) ```json {
from line 402
## Delete RBAC Group -**delete** `/v1/organizations/rbac_groups/{group_id}` +**DELETE** `/v1/organizations/rbac_groups/{group_id}` Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API. The 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. -### Path Parameters +### Path parameters - `group_id: string` ID of the RBAC Group. -### Header Parameters +### Headers - `"anthropic-beta": optional array of string`
from line 424
### Returns -- `RbacGroupDeleted object { id, type }` +- `RbacGroupDeleted object` - `id: string`
from line 436
For RBAC Groups, this is always `"rbac_group_deleted"`. - - `"rbac_group_deleted"` + default: rbac_group_deleted ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \
from line 447
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
from line 456
} ``` -## Domain Types +## Domain types ### Rbac Group -- `RbacGroup object { id, created_at, name, 4 more }` +- `RbacGroup object` - `id: string`
from line 470
RFC 3339 timestamp of when the RBAC Group was created. + format: date-time + - `name: string` Name of the RBAC Group. Not uniqueness-enforced.
from line 494
For RBAC Groups, this is always `"rbac_group"`. - - `"rbac_group"` + default: rbac_group - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. + format: date-time + ### Rbac Group Deleted -- `RbacGroupDeleted object { id, type }` +- `RbacGroupDeleted object` - `id: string`
from line 516
For RBAC Groups, this is always `"rbac_group_deleted"`. - - `"rbac_group_deleted"` + default: rbac_group_deleted -# Members +## RBAC Groups › Members -## List RBAC Group Members +### List RBAC Group Members -**get** `/v1/organizations/rbac_groups/{group_id}/members` +**GET** `/v1/organizations/rbac_groups/{group_id}/members` List members of an RBAC Group. The 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. -### Path Parameters +#### Path parameters - `group_id: string` ID of the RBAC Group. -### Query Parameters +#### Query parameters - `limit: optional number`
from line 542
Defaults to `20`. Ranges from `1` to `1000`. + default: 20, maximum: 1000, minimum: 1 + - `page: optional string` Optionally set to the `next_page` token from the previous response. -### Header Parameters +#### Headers - `"anthropic-beta": optional array of string`
from line 556
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Returns +#### Returns - `data: array of RbacGroupMember`
from line 564
RFC 3339 timestamp of when the User was added to the RBAC Group. + format: date-time + - `email: string` Email of the User.
from line 580
For RBAC Group Members, this is always `"rbac_group_member"`. - - `"rbac_group_member"` + default: rbac_group_member - `user_id: string`
from line 594
Token to provide in as `page` in the subsequent request to retrieve the next page of data. -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +##### Response (200) ```json {
from line 620
} ``` -## Add RBAC Group Member +### Add RBAC Group Member -**post** `/v1/organizations/rbac_groups/{group_id}/members` +**POST** `/v1/organizations/rbac_groups/{group_id}/members` Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API. The 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. -### Path Parameters +#### Path parameters - `group_id: string` ID of the RBAC Group. -### Header Parameters +#### Headers - `"anthropic-beta": optional array of string`
from line 642
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Body Parameters +#### Body parameters - `user_id: string` ID of the User. -### Returns +#### Returns -- `RbacGroupMember object { created_at, email, group_id, 2 more }` +- `RbacGroupMember object` - `created_at: string` RFC 3339 timestamp of when the User was added to the RBAC Group. + format: date-time + - `email: string` Email of the User.
from line 672
For RBAC Group Members, this is always `"rbac_group_member"`. - - `"rbac_group_member"` + default: rbac_group_member - `user_id: string` ID of the User. -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 690
}' ``` -#### Response +##### Response (200) ```json {
from line 702
} ``` -## Remove RBAC Group Member +### Remove RBAC Group Member -**delete** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}` +**DELETE** `/v1/organizations/rbac_groups/{group_id}/members/{user_id}` Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API. The 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. -### Path Parameters +#### Path parameters - `group_id: string`
from line 720
ID of the User. -### Header Parameters +#### Headers - `"anthropic-beta": optional array of string`
from line 728
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Returns +#### Returns -- `RbacGroupMemberDeleted object { group_id, type, user_id }` +- `RbacGroupMemberDeleted object` - `group_id: string`
from line 740
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`. - - `"rbac_group_member_deleted"` + default: rbac_group_member_deleted - `user_id: string` ID of the User. -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \
from line 755
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +##### Response (200) ```json {
from line 764
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } ``` - -## Domain Types - -### Rbac Group Member - -- `RbacGroupMember object { created_at, email, group_id, 2 more }` - - - `created_at: string` - - RFC 3339 timestamp of when the User was added to the RBAC Group. - - - `email: string` - - Email of the User. - - - `group_id: string` - - ID of the RBAC Group. - - - `type: "rbac_group_member"` - - Object type. - - For RBAC Group Members, this is always `"rbac_group_member"`. - - - `"rbac_group_member"` - - - `user_id: string` - - ID of the User. - -### Rbac Group Member Deleted - -- `RbacGroupMemberDeleted object { group_id, type, user_id }` - - - `group_id: string` - - ID of the RBAC Group. - - - `type: "rbac_group_member_deleted"` - - Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`. - - - `"rbac_group_member_deleted"` - - - `user_id: string` - - ID of the User.