--- title: RBAC Roles url: https://platform.claude.com/docs/en/api/ruby/beta/organization/rbac_roles --- # RBAC Roles ## List RBAC Roles `beta.organization.rbac_roles.list(**kwargs) -> PageCursor` **GET** `/v1/organizations/rbac_roles` List RBAC Roles in the organization. The RBAC Roles 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 BetaRBACRole` - `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. format: date-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. format: date-time - `name: String` **Deprecated**: Use `display_name` instead; `name` always has the same value. Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`. ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") page = anthropic.beta.organization.rbac_roles.list puts(page) ``` #### Response (200) ```json { "data": [ { "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" } ], "has_more": true, "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0" } ``` ## 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` 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. format: date-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. format: date-time - `name: String` **Deprecated**: Use `display_name` instead; `name` always has the same value. Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`. ### Example ```ruby 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) ``` #### Response (200) ```json { "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" } ``` ## Domain types ### Beta RBAC Role - `class BetaRBACRole` - `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. format: date-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. format: date-time - `name: String` **Deprecated**: Use `display_name` instead; `name` always has the same value. Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`. ## RBAC Roles › Permissions ### List RBAC Role Permissions `beta.organization.rbac_roles.permissions.list(rbac_role_id, **kwargs) -> PageCursor` **GET** `/v1/organizations/rbac_roles/{rbac_role_id}/permissions` List the permissions an RBAC Role grants. The RBAC Roles API is available to Claude Enterprise organizations only. #### Parameters - `rbac_role_id: String` (path parameter) ID of the RBAC Role. - `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 BetaRBACRolePermission` - `type: :rbac_role_permission` Object type. For RBAC Role Permissions, this is always `"rbac_role_permission"`. - `action: String` Action the permission grants on the resource. The vocabulary follows the resource: an `organization` grant carries a product-feature entitlement (for example `chat`), an admin-panel permission entitlement (`permission_*`), or a blanket capability-access mode — `capability_access_all` grants every product-feature entitlement, and `capability_access_all_ga` grants the generally-available subset as it stands at permission-check time; neither mode grants model-access entitlements. A consumer enumerating a role's per-feature grants should treat a blanket row as granting every product-feature entitlement it covers, or it will under-report the role's effective access. A `connector_tool` grant carries a tool-access action (`use` or `always_allow`); a `connector_scope` grant carries the scope action `grant` (the role may receive the named OAuth scope when tokens are minted for the connector); `connector` and `all_connectors` grants carry a tool-access action, the scope action, or an authentication-method action (`interactive` or `managed`). - `resource: BetaRBACOrganizationPermissionResource | BetaRBACConnectorToolPermissionResource | BetaRBACConnectorScopePermissionResource | 2 more` What the permission applies to. A tagged union: `type` names the kind of resource and determines which identifier fields are present. - `class BetaRBACOrganizationPermissionResource` - `type: :organization` Kind of resource the permission applies to. - `organization_id: String` UUID of the organization the permission applies to. - `class BetaRBACConnectorToolPermissionResource` - `type: :connector_tool` Kind of resource the permission applies to. - `connector_id: String` ID of the connector the permission applies to. - `tool_name: String` Published name of the connector tool the permission applies to. When the published name contains characters outside `[a-zA-Z0-9_-]` (or collides with a reserved form), it is server-encoded into a stable `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus a hash — from which the published name is not recoverable. - `class BetaRBACConnectorScopePermissionResource` - `type: :connector_scope` Kind of resource the permission applies to. - `connector_id: String` ID of the connector the permission applies to. - `scope: String` OAuth scope the permission names — the role may receive this scope when tokens are minted for the connector. Subject to the same encoding rule as `tool_name`: a scope containing characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form) appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth scopes routinely contain `:` and `/`, so most appear encoded. - `class BetaRBACConnectorPermissionResource` - `type: :connector` Kind of resource the permission applies to. - `connector_id: String` ID of the connector the permission applies to. - `class BetaRBACAllConnectorsPermissionResource` - `type: :all_connectors` Kind of resource the permission applies to. #### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") page = anthropic.beta.organization.rbac_roles.permissions.list("rbac_role_id") puts(page) ``` ##### Response (200) ```json { "data": [ { "action": "use", "resource": { "organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e", "type": "organization" }, "type": "rbac_role_permission" } ], "has_more": true, "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0" } ```