Repository Public
1---2title: Roles3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles4---56# Roles78## List Compliance Roles910**GET** `/v1/compliance/organizations/{org_uuid}/roles`1112List Compliance Roles1314### Path parameters1516- `org_uuid: string`1718 The organization UUID1920### Query parameters2122- `limit: optional number`2324 Maximum results (default: 500, max: 1000)2526 default: 500, maximum: 1000, minimum: 12728- `page: optional string`2930 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.3132### Headers3334- `"x-api-key": optional string`3536### Returns3738- `data: array of object`3940 List of roles4142 - `id: string`4344 Role identifier (tagged ID)4546 - `created_at: string or null`4748 Role creation timestamp (RFC 3339)4950 format: date-time5152 - `description: string`5354 Role description5556 - `name: string`5758 Role name5960 - `updated_at: string or null`6162 Role last-updated timestamp (RFC 3339)6364 format: date-time6566- `has_more: boolean`6768 Whether more records exist beyond the current result set6970- `next_page: string or null`7172 Token to retrieve the next page. Use this as the 'page' parameter in your next request7374### Example7576```bash77curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \78 -H 'anthropic-version: 2023-06-01' \79 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"80```8182#### Response (200)8384```json85{86 "data": [87 {88 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",89 "created_at": "2025-03-12T18:22:41.123456Z",90 "description": "Full administrative access to organization settings and members",91 "name": "Organization Admin",92 "updated_at": "2025-03-14T09:05:17.456789Z"93 }94 ],95 "has_more": true,96 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="97}98```99100## Get Compliance Role101102**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`103104Get Compliance Role105106### Path parameters107108- `org_uuid: string`109110 The organization UUID111112- `role_id: string`113114 The role ID (tagged ID, e.g., rbac_role_abc123)115116### Headers117118- `"x-api-key": optional string`119120### Returns121122- `id: string`123124 Role identifier (tagged ID)125126- `created_at: string or null`127128 Role creation timestamp (RFC 3339)129130 format: date-time131132- `description: string`133134 Role description135136- `name: string`137138 Role name139140- `updated_at: string or null`141142 Role last-updated timestamp (RFC 3339)143144 format: date-time145146### Example147148```bash149curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \150 -H 'anthropic-version: 2023-06-01' \151 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"152```153154#### Response (200)155156```json157{158 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",159 "created_at": "2025-03-12T18:22:41.123456Z",160 "description": "Full administrative access to organization settings and members",161 "name": "Organization Admin",162 "updated_at": "2025-03-14T09:05:17.456789Z"163}164```165166## Domain types167168### Role Retrieve Response169170- `RoleRetrieveResponse object`171172 Role information for compliance responses.173174 - `id: string`175176 Role identifier (tagged ID)177178 - `created_at: string or null`179180 Role creation timestamp (RFC 3339)181182 format: date-time183184 - `description: string`185186 Role description187188 - `name: string`189190 Role name191192 - `updated_at: string or null`193194 Role last-updated timestamp (RFC 3339)195196 format: date-time197198### Role List Response199200- `RoleListResponse object`201202 Role information for compliance responses.203204 - `id: string`205206 Role identifier (tagged ID)207208 - `created_at: string or null`209210 Role creation timestamp (RFC 3339)211212 format: date-time213214 - `description: string`215216 Role description217218 - `name: string`219220 Role name221222 - `updated_at: string or null`223224 Role last-updated timestamp (RFC 3339)225226 format: date-time227228## Roles › Permissions229230### List Compliance Role Permissions231232**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`233234List Compliance Role Permissions235236#### Path parameters237238- `org_uuid: string`239240 The organization UUID241242- `role_id: string`243244 The role ID (tagged ID, e.g., rbac_role_abc123)245246#### Query parameters247248- `limit: optional number`249250 Maximum results (default: 500, max: 1000)251252 default: 500, maximum: 1000, minimum: 1253254- `page: optional string`255256 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.257258#### Headers259260- `"x-api-key": optional string`261262#### Returns263264- `data: array of object`265266 List of permissions267268 - `action: string`269270 Action permitted on the resource271272 - `resource_id: string`273274 Identifier of the resource the permission applies to275276 - `resource_type: string`277278 Type of resource the permission applies to279280- `has_more: boolean`281282 Whether more records exist beyond the current result set283284- `next_page: string or null`285286 Token to retrieve the next page. Use this as the 'page' parameter in your next request287288#### Example289290```bash291curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \292 -H 'anthropic-version: 2023-06-01' \293 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"294```295296##### Response (200)297298```json299{300 "data": [301 {302 "action": "claude_code",303 "resource_id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",304 "resource_type": "organization"305 }306 ],307 "has_more": true,308 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="309}310```311