Claude Platform Docs

Get RBAC Role

beta.organization.rbac_roles.retrieve(rbac_role_id) -> BetaRBACRole
GET/v1/organizations/rbac_roles/{rbac_role_id}

Retrieve an RBAC Role by ID.

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

Parameters
rbac_role_id: String⁠Path parameter

ID of the RBAC Role.

Returns
class BetaRBACRole { type: :rbac_role, id, created_at, 3 more }
type: :rbac_role

Object type.

For RBAC Roles, this is always "rbac_role".

id: String

ID of the RBAC Role.

created_at: Time

RFC 3339 datetime string indicating when the RBAC Role was created.

formatdate-time
display_name: String

Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its id.

updated_at: Time

RFC 3339 datetime string indicating when the RBAC Role was last updated.

formatdate-time
name: String⁠Deprecated

Deprecated: use display_name instead. Name of the RBAC Role; always the same value as display_name.

Use `display_name` instead; `name` always has the same value.
Get RBAC Role
require "anthropic"

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

beta_rbac_role = anthropic.beta.organization.rbac_roles.retrieve("rbac_role_id")

puts(beta_rbac_role)
Returns Examples
Response 200
{
  "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_name": "Project Editor",
  "name": "Project Editor",
  "type": "rbac_role",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}