Repository Public
1---2title: RBAC Roles3url: https://platform.claude.com/docs/en/api/beta/organization/rbac_roles4---56# RBAC Roles78## List RBAC Roles910**GET** `/v1/organizations/rbac_roles`1112List RBAC Roles in the organization.1314The RBAC Roles API is available to Claude Enterprise organizations only.1516### Query parameters1718- `limit: optional number`1920 Number of items to return per page.2122 Defaults to `20`. Ranges from `1` to `1000`.2324 default: 20, maximum: 1000, minimum: 12526- `page: optional string`2728 Optionally set to the `next_page` token from the previous response.2930### Returns3132- `data: array of BetaRBACRole`3334 - `type: "rbac_role"`3536 Object type.3738 For RBAC Roles, this is always `"rbac_role"`.3940 default: rbac_role4142 - `id: string`4344 ID of the RBAC Role.4546 - `created_at: string`4748 RFC 3339 datetime string indicating when the RBAC Role was created.4950 format: date-time5152 - `name: string`5354 Name of the RBAC Role.5556 - `updated_at: string`5758 RFC 3339 datetime string indicating when the RBAC Role was last updated.5960 format: date-time6162- `has_more: boolean`6364 Indicates whether there are more results beyond this page.6566- `next_page: string or null`6768 Opaque cursor for the next page. Pass as the `page` parameter on the next69 request.7071### Example7273```bash74curl https://api.anthropic.com/v1/organizations/rbac_roles \75 -H 'anthropic-version: 2023-06-01' \76 -H "X-Api-Key: $ANTHROPIC_API_KEY"77```7879#### Response (200)8081```json82{83 "data": [84 {85 "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",86 "created_at": "2024-10-30T23:58:27.427722Z",87 "name": "Project Editor",88 "type": "rbac_role",89 "updated_at": "2024-10-30T23:58:27.427722Z"90 }91 ],92 "has_more": true,93 "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"94}95```9697## Get RBAC Role9899**GET** `/v1/organizations/rbac_roles/{role_id}`100101Retrieve an RBAC Role by ID.102103The RBAC Roles API is available to Claude Enterprise organizations only.104105### Path parameters106107- `role_id: string`108109 ID of the RBAC Role.110111### Returns112113- `BetaRBACRole object`114115 - `type: "rbac_role"`116117 Object type.118119 For RBAC Roles, this is always `"rbac_role"`.120121 default: rbac_role122123 - `id: string`124125 ID of the RBAC Role.126127 - `created_at: string`128129 RFC 3339 datetime string indicating when the RBAC Role was created.130131 format: date-time132133 - `name: string`134135 Name of the RBAC Role.136137 - `updated_at: string`138139 RFC 3339 datetime string indicating when the RBAC Role was last updated.140141 format: date-time142143### Example144145```bash146curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \147 -H 'anthropic-version: 2023-06-01' \148 -H "X-Api-Key: $ANTHROPIC_API_KEY"149```150151#### Response (200)152153```json154{155 "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",156 "created_at": "2024-10-30T23:58:27.427722Z",157 "name": "Project Editor",158 "type": "rbac_role",159 "updated_at": "2024-10-30T23:58:27.427722Z"160}161```162163## Domain types164165### Beta RBAC Role166167- `BetaRBACRole object`168169 - `type: "rbac_role"`170171 Object type.172173 For RBAC Roles, this is always `"rbac_role"`.174175 default: rbac_role176177 - `id: string`178179 ID of the RBAC Role.180181 - `created_at: string`182183 RFC 3339 datetime string indicating when the RBAC Role was created.184185 format: date-time186187 - `name: string`188189 Name of the RBAC Role.190191 - `updated_at: string`192193 RFC 3339 datetime string indicating when the RBAC Role was last updated.194195 format: date-time196197## RBAC Roles › Permissions198199### List RBAC Role Permissions200201**GET** `/v1/organizations/rbac_roles/{role_id}/permissions`202203List the permissions an RBAC Role grants.204205The RBAC Roles API is available to Claude Enterprise organizations only.206207#### Path parameters208209- `role_id: string`210211 ID of the RBAC Role.212213#### Query parameters214215- `limit: optional number`216217 Number of items to return per page.218219 Defaults to `20`. Ranges from `1` to `1000`.220221 default: 20, maximum: 1000, minimum: 1222223- `page: optional string`224225 Optionally set to the `next_page` token from the previous response.226227#### Returns228229- `data: array of BetaRBACRolePermission`230231 - `type: "rbac_role_permission"`232233 Object type.234235 For RBAC Role Permissions, this is always `"rbac_role_permission"`.236237 default: rbac_role_permission238239 - `action: string`240241 Action the permission grants on the resource.242243 The vocabulary follows the resource: an `organization` grant carries a244 product-feature entitlement (for example `chat`), an admin-panel245 permission entitlement (`permission_*`), or a blanket capability-access246 mode — `capability_access_all` grants every product-feature entitlement,247 and `capability_access_all_ga` grants the generally-available subset as248 it stands at permission-check time; neither mode grants model-access249 entitlements. A consumer enumerating a role's per-feature grants should250 treat a blanket row as granting every product-feature entitlement it251 covers, or it will under-report the role's effective access. A `connector_tool` grant carries252 a tool-access action (`use` or `always_allow`); a `connector_scope` grant253 carries the scope action `grant` (the role may receive the named OAuth254 scope when tokens are minted for the connector); `connector` and255 `all_connectors` grants carry a tool-access action, the scope action, or256 an authentication-method action (`interactive` or `managed`).257258 - `resource: Organization or ConnectorTool or ConnectorScope or 2 more`259260 What the permission applies to.261262 A tagged union: `type` names the kind of resource and determines which263 identifier fields are present.264265 - `Organization object`266267 - `type: "organization"`268269 Kind of resource the permission applies to.270271 default: organization272273 - `organization_id: string`274275 UUID of the organization the permission applies to.276277 - `ConnectorTool object`278279 - `type: "connector_tool"`280281 Kind of resource the permission applies to.282283 default: connector_tool284285 - `connector_id: string`286287 ID of the connector the permission applies to.288289 - `tool_name: string`290291 Published name of the connector tool the permission applies to.292293 When the published name contains characters outside `[a-zA-Z0-9_-]` (or294 collides with a reserved form), it is server-encoded into a stable295 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus296 a hash — from which the published name is not recoverable.297298 - `ConnectorScope object`299300 - `type: "connector_scope"`301302 Kind of resource the permission applies to.303304 default: connector_scope305306 - `connector_id: string`307308 ID of the connector the permission applies to.309310 - `scope: string`311312 OAuth scope the permission names — the role may receive this scope when313 tokens are minted for the connector.314315 Subject to the same encoding rule as `tool_name`: a scope containing316 characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form)317 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth318 scopes routinely contain `:` and `/`, so most appear encoded.319320 - `Connector object`321322 - `type: "connector"`323324 Kind of resource the permission applies to.325326 default: connector327328 - `connector_id: string`329330 ID of the connector the permission applies to.331332 - `AllConnectors object`333334 - `type: "all_connectors"`335336 Kind of resource the permission applies to.337338 default: all_connectors339340- `has_more: boolean`341342 Indicates whether there are more results beyond this page.343344- `next_page: string or null`345346 Opaque cursor for the next page. Pass as the `page` parameter on the next347 request.348349#### Example350351```bash352curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \353 -H 'anthropic-version: 2023-06-01' \354 -H "X-Api-Key: $ANTHROPIC_API_KEY"355```356357##### Response (200)358359```json360{361 "data": [362 {363 "action": "use",364 "resource": {365 "organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e",366 "type": "organization"367 },368 "type": "rbac_role_permission"369 }370 ],371 "has_more": true,372 "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"373}374```375