Claude Platform Docs

Get RBAC Group

client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): 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
rbacGroupID: string⁠Path parameter

ID of the RBAC Group.

Returns
interface BetaRBACGroup { type: "rbac_group"; id; created_at; /* 4 more */ }
type: "rbac_group"

Object type.

For RBAC Groups, this is always "rbac_group".

defaultrbac_group
id: string

ID of the RBAC Group.

created_at: string

RFC 3339 timestamp of when the RBAC Group was created.

formatdate-time
name: string

Name of the RBAC Group. Not uniqueness-enforced.

role_ids: Array<string> | null

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.

One of the following:
"direct"
"scim"
updated_at: string

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

formatdate-time
Get RBAC Group
import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const betaRBACGroup = await client.beta.organization.rbacGroups.retrieve("rbac_group_id");

console.log(betaRBACGroup.id);
Returns Examples
Response 200
{
  "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "name": "Engineering",
  "role_ids": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "source_type": "direct",
  "type": "rbac_group",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}