---
title: RBAC Groups
url: https://platform.claude.com/docs/en/api/ruby/beta/organization/rbac_groups
---

# RBAC Groups

## Create RBAC Group

`beta.organization.rbac_groups.create(**kwargs) -> BetaRBACGroup`

**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 available to Claude Enterprise organizations only.

### Parameters

- `name: String`

  Name of the RBAC Group. Not uniqueness-enforced.

  minLength: 1, maxLength: 255

### Returns

- `class BetaRBACGroup`

  - `type: :rbac_group`

    Object type.

    For RBAC Groups, this is always `"rbac_group"`.

  - `id: String`

    ID of the RBAC Group.

  - `created_at: Time`

    RFC 3339 timestamp of when the RBAC Group was created.

    format: date-time

  - `name: String`

    Name of the RBAC Group. Not uniqueness-enforced.

  - `role_ids: Array[String]`

    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.

  - `source_type: :direct | :scim`

    How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.

    - `:direct`

    - `:scim`

  - `updated_at: Time`

    RFC 3339 timestamp of when the RBAC Group was last updated.

    format: date-time

### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_rbac_group = anthropic.beta.organization.rbac_groups.create(name: "Engineering")

puts(beta_rbac_group)
```

#### Response (200)

```json
{
  "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "name": "Engineering",
  "role_ids": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "roles": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "source_type": "direct",
  "type": "rbac_group",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}
```

## List RBAC Groups

`beta.organization.rbac_groups.list(**kwargs) -> PageCursor<BetaRBACGroup>`

**GET** `/v1/organizations/rbac_groups`

List RBAC Groups in the Claude Enterprise tenant.

The RBAC Groups API is available to Claude Enterprise organizations only.

### Parameters

- `limit: Integer` (query parameter)

  Number of items to return per page.

  Defaults to `20`. Ranges from `1` to `1000`.

  minimum: 1, maximum: 1000

- `page: String` (query parameter)

  Optionally set to the `next_page` token from the previous response.

### Returns

- `class BetaRBACGroup`

  - `type: :rbac_group`

    Object type.

    For RBAC Groups, this is always `"rbac_group"`.

  - `id: String`

    ID of the RBAC Group.

  - `created_at: Time`

    RFC 3339 timestamp of when the RBAC Group was created.

    format: date-time

  - `name: String`

    Name of the RBAC Group. Not uniqueness-enforced.

  - `role_ids: Array[String]`

    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.

  - `source_type: :direct | :scim`

    How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.

    - `:direct`

    - `:scim`

  - `updated_at: Time`

    RFC 3339 timestamp of when the RBAC Group was last updated.

    format: date-time

### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

page = anthropic.beta.organization.rbac_groups.list

puts(page)
```

#### Response (200)

```json
{
  "data": [
    {
      "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "name": "Engineering",
      "role_ids": [
        "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
      ],
      "roles": [
        "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
      ],
      "source_type": "direct",
      "type": "rbac_group",
      "updated_at": "2024-10-30T23:58:27.427722Z"
    }
  ],
  "has_more": false,
  "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
}
```

## Get RBAC Group

`beta.organization.rbac_groups.retrieve(rbac_group_id) -> BetaRBACGroup`

**GET** `/v1/organizations/rbac_groups/{rbac_group_id}`

Retrieve an RBAC Group by ID.

The RBAC Groups API is available to Claude Enterprise organizations only.

### Parameters

- `rbac_group_id: String` (path parameter)

  ID of the RBAC Group.

### Returns

- `class BetaRBACGroup`

  - `type: :rbac_group`

    Object type.

    For RBAC Groups, this is always `"rbac_group"`.

  - `id: String`

    ID of the RBAC Group.

  - `created_at: Time`

    RFC 3339 timestamp of when the RBAC Group was created.

    format: date-time

  - `name: String`

    Name of the RBAC Group. Not uniqueness-enforced.

  - `role_ids: Array[String]`

    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.

  - `source_type: :direct | :scim`

    How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.

    - `:direct`

    - `:scim`

  - `updated_at: Time`

    RFC 3339 timestamp of when the RBAC Group was last updated.

    format: date-time

### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_rbac_group = anthropic.beta.organization.rbac_groups.retrieve("rbac_group_id")

puts(beta_rbac_group)
```

#### Response (200)

```json
{
  "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "name": "Engineering",
  "role_ids": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "roles": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "source_type": "direct",
  "type": "rbac_group",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}
```

## Update RBAC Group

`beta.organization.rbac_groups.update(rbac_group_id, **kwargs) -> BetaRBACGroup`

**POST** `/v1/organizations/rbac_groups/{rbac_group_id}`

Update 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.

The RBAC Groups API is available to Claude Enterprise organizations only.

### Parameters

- `rbac_group_id: String` (path parameter)

  ID of the RBAC Group.

- `name: String`

  Name of the RBAC Group. Not uniqueness-enforced.

  minLength: 1, maxLength: 255

### Returns

- `class BetaRBACGroup`

  - `type: :rbac_group`

    Object type.

    For RBAC Groups, this is always `"rbac_group"`.

  - `id: String`

    ID of the RBAC Group.

  - `created_at: Time`

    RFC 3339 timestamp of when the RBAC Group was created.

    format: date-time

  - `name: String`

    Name of the RBAC Group. Not uniqueness-enforced.

  - `role_ids: Array[String]`

    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.

  - `source_type: :direct | :scim`

    How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.

    - `:direct`

    - `:scim`

  - `updated_at: Time`

    RFC 3339 timestamp of when the RBAC Group was last updated.

    format: date-time

### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_rbac_group = anthropic.beta.organization.rbac_groups.update("rbac_group_id")

puts(beta_rbac_group)
```

#### Response (200)

```json
{
  "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "name": "Engineering",
  "role_ids": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "roles": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "source_type": "direct",
  "type": "rbac_group",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}
```

## Delete RBAC Group

`beta.organization.rbac_groups.delete(rbac_group_id) -> RBACGroupDeleteResponse`

**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}`

Delete 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.

The RBAC Groups API is available to Claude Enterprise organizations only.

### Parameters

- `rbac_group_id: String` (path parameter)

  ID of the RBAC Group.

### Returns

- `class RBACGroupDeleteResponse`

  - `type: :rbac_group_deleted`

    Deleted object type.

    For RBAC Groups, this is always `"rbac_group_deleted"`.

  - `id: String`

    ID of the RBAC Group.

### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

rbac_group = anthropic.beta.organization.rbac_groups.delete("rbac_group_id")

puts(rbac_group)
```

#### Response (200)

```json
{
  "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "type": "rbac_group_deleted"
}
```

## Domain types

### Beta RBAC Group

- `class BetaRBACGroup`

  - `type: :rbac_group`

    Object type.

    For RBAC Groups, this is always `"rbac_group"`.

  - `id: String`

    ID of the RBAC Group.

  - `created_at: Time`

    RFC 3339 timestamp of when the RBAC Group was created.

    format: date-time

  - `name: String`

    Name of the RBAC Group. Not uniqueness-enforced.

  - `role_ids: Array[String]`

    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.

  - `source_type: :direct | :scim`

    How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.

    - `:direct`

    - `:scim`

  - `updated_at: Time`

    RFC 3339 timestamp of when the RBAC Group was last updated.

    format: date-time

### RBAC Group Delete Response

- `class RBACGroupDeleteResponse`

  - `type: :rbac_group_deleted`

    Deleted object type.

    For RBAC Groups, this is always `"rbac_group_deleted"`.

  - `id: String`

    ID of the RBAC Group.

## RBAC Groups › Members

### List RBAC Group Members

`beta.organization.rbac_groups.members.list(rbac_group_id, **kwargs) -> PageCursor<BetaRBACGroupMember>`

**GET** `/v1/organizations/rbac_groups/{rbac_group_id}/members`

List members of an RBAC Group.

The RBAC Groups API is available to Claude Enterprise organizations only.

#### Parameters

- `rbac_group_id: String` (path parameter)

  ID of the RBAC Group.

- `limit: Integer` (query parameter)

  Number of items to return per page.

  Defaults to `20`. Ranges from `1` to `1000`.

  minimum: 1, maximum: 1000

- `page: String` (query parameter)

  Optionally set to the `next_page` token from the previous response.

#### Returns

- `class BetaRBACGroupMember`

  - `type: :rbac_group_member`

    Object type.

    For RBAC Group Members, this is always `"rbac_group_member"`.

  - `created_at: Time`

    RFC 3339 timestamp of when the User was added to the RBAC Group.

    format: date-time

  - `email: String`

    Email of the User.

  - `rbac_group_id: String`

    ID of the RBAC Group.

  - `user_id: String`

    ID of the User.

#### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

page = anthropic.beta.organization.rbac_groups.members.list("rbac_group_id")

puts(page)
```

##### Response (200)

```json
{
  "data": [
    {
      "created_at": "2024-10-30T23:58:27.427722Z",
      "email": "user@emaildomain.com",
      "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
      "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
      "type": "rbac_group_member",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
    }
  ],
  "has_more": false,
  "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
}
```

### Add RBAC Group Member

`beta.organization.rbac_groups.members.add(rbac_group_id, **kwargs) -> BetaRBACGroupMember`

**POST** `/v1/organizations/rbac_groups/{rbac_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 while an organization in the tenant uses SCIM provisioning.

The RBAC Groups API is available to Claude Enterprise organizations only.

#### Parameters

- `rbac_group_id: String` (path parameter)

  ID of the RBAC Group.

- `user_id: String`

  ID of the User.

#### Returns

- `class BetaRBACGroupMember`

  - `type: :rbac_group_member`

    Object type.

    For RBAC Group Members, this is always `"rbac_group_member"`.

  - `created_at: Time`

    RFC 3339 timestamp of when the User was added to the RBAC Group.

    format: date-time

  - `email: String`

    Email of the User.

  - `rbac_group_id: String`

    ID of the RBAC Group.

  - `user_id: String`

    ID of the User.

#### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_rbac_group_member = anthropic.beta.organization.rbac_groups.members.add(
  "rbac_group_id",
  user_id: "user_01WCz1FkmYMm4gnmykNKUu3Q"
)

puts(beta_rbac_group_member)
```

##### Response (200)

```json
{
  "created_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "type": "rbac_group_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```

### Remove RBAC Group Member

`beta.organization.rbac_groups.members.remove(user_id, **kwargs) -> MemberRemoveResponse`

**DELETE** `/v1/organizations/rbac_groups/{rbac_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 while an organization in the tenant uses SCIM provisioning.

The RBAC Groups API is available to Claude Enterprise organizations only.

#### Parameters

- `rbac_group_id: String` (path parameter)

  ID of the RBAC Group.

- `user_id: String` (path parameter)

  ID of the User.

#### Returns

- `class MemberRemoveResponse`

  - `type: :rbac_group_member_deleted`

    Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

  - `rbac_group_id: String`

    ID of the RBAC Group.

  - `user_id: String`

    ID of the User.

#### Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

member = anthropic.beta.organization.rbac_groups.members.remove("user_id", rbac_group_id: "rbac_group_id")

puts(member)
```

##### Response (200)

```json
{
  "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "type": "rbac_group_member_deleted",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```