Repository Public
1---2title: Groups3url: https://platform.claude.com/docs/en/api/compliance/groups4---56# Groups78## List Compliance Groups910**GET** `/v1/compliance/groups`1112List Compliance Groups1314### Query parameters1516- `limit: optional number`1718 Maximum results (default: 500, max: 1000)1920 default: 500, maximum: 1000, minimum: 12122- `name_prefix: optional string`2324 Filter groups by name prefix2526 default: ""2728- `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 groups4142 - `id: string`4344 Group identifier (tagged ID)4546 - `created_at: string or null`4748 Group creation timestamp (RFC 3339)4950 format: date-time5152 - `description: string`5354 Group description5556 - `name: string`5758 Group name5960 - `roles: array of string or null`6162 Role IDs assigned to this group.6364 - `source_type: string`6566 How the group was created ('direct' or 'scim')6768 - `updated_at: string or null`6970 Group last-updated timestamp (RFC 3339)7172 format: date-time7374- `has_more: boolean`7576 Whether more records exist beyond the current result set7778- `next_page: string or null`7980 Token to retrieve the next page. Use this as the 'page' parameter in your next request8182### Example8384```bash85curl https://api.anthropic.com/v1/compliance/groups \86 -H 'anthropic-version: 2023-06-01' \87 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"88```8990#### Response (200)9192```json93{94 "data": [95 {96 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",97 "created_at": "2025-03-12T18:22:41.123456Z",98 "description": "All members of the engineering organization",99 "name": "Engineering Team",100 "roles": [101 "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",102 "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"103 ],104 "source_type": "scim",105 "updated_at": "2025-03-14T09:05:17.456789Z"106 }107 ],108 "has_more": true,109 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="110}111```112113## Get Compliance Group114115**GET** `/v1/compliance/groups/{group_id}`116117Get Compliance Group118119### Path parameters120121- `group_id: string`122123 The group ID (tagged ID, e.g., rbac_group_abc123)124125### Headers126127- `"x-api-key": optional string`128129### Returns130131- `id: string`132133 Group identifier (tagged ID)134135- `created_at: string or null`136137 Group creation timestamp (RFC 3339)138139 format: date-time140141- `description: string`142143 Group description144145- `name: string`146147 Group name148149- `roles: array of string or null`150151 Role IDs assigned to this group.152153- `source_type: string`154155 How the group was created ('direct' or 'scim')156157- `updated_at: string or null`158159 Group last-updated timestamp (RFC 3339)160161 format: date-time162163### Example164165```bash166curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID \167 -H 'anthropic-version: 2023-06-01' \168 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"169```170171#### Response (200)172173```json174{175 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",176 "created_at": "2025-03-12T18:22:41.123456Z",177 "description": "All members of the engineering organization",178 "name": "Engineering Team",179 "roles": [180 "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",181 "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"182 ],183 "source_type": "scim",184 "updated_at": "2025-03-14T09:05:17.456789Z"185}186```187188## Domain types189190### Group Retrieve Response191192- `GroupRetrieveResponse object`193194 Group information for compliance responses.195196 - `id: string`197198 Group identifier (tagged ID)199200 - `created_at: string or null`201202 Group creation timestamp (RFC 3339)203204 format: date-time205206 - `description: string`207208 Group description209210 - `name: string`211212 Group name213214 - `roles: array of string or null`215216 Role IDs assigned to this group.217218 - `source_type: string`219220 How the group was created ('direct' or 'scim')221222 - `updated_at: string or null`223224 Group last-updated timestamp (RFC 3339)225226 format: date-time227228### Group List Response229230- `GroupListResponse object`231232 Group information for compliance responses.233234 - `id: string`235236 Group identifier (tagged ID)237238 - `created_at: string or null`239240 Group creation timestamp (RFC 3339)241242 format: date-time243244 - `description: string`245246 Group description247248 - `name: string`249250 Group name251252 - `roles: array of string or null`253254 Role IDs assigned to this group.255256 - `source_type: string`257258 How the group was created ('direct' or 'scim')259260 - `updated_at: string or null`261262 Group last-updated timestamp (RFC 3339)263264 format: date-time265266## Groups › Members267268### List Compliance Group Members269270**GET** `/v1/compliance/groups/{group_id}/members`271272List Compliance Group Members273274#### Path parameters275276- `group_id: string`277278 The group ID (tagged ID, e.g., rbac_group_abc123)279280#### Query parameters281282- `limit: optional number`283284 Maximum results (default: 500, max: 1000)285286 default: 500, maximum: 1000, minimum: 1287288- `page: optional string`289290 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.291292#### Headers293294- `"x-api-key": optional string`295296#### Returns297298- `data: array of object`299300 List of group members301302 - `created_at: string or null`303304 Membership creation timestamp (RFC 3339)305306 format: date-time307308 - `email: string`309310 Member email address311312 - `updated_at: string or null`313314 Membership last-updated timestamp (RFC 3339)315316 format: date-time317318 - `user_id: string`319320 Member user identifier (tagged ID)321322- `has_more: boolean`323324 Whether more records exist beyond the current result set325326- `next_page: string or null`327328 Token to retrieve the next page. Use this as the 'page' parameter in your next request329330#### Example331332```bash333curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \334 -H 'anthropic-version: 2023-06-01' \335 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"336```337338##### Response (200)339340```json341{342 "data": [343 {344 "created_at": "2025-03-12T18:22:41.123456Z",345 "email": "jane.doe@example.com",346 "updated_at": "2025-03-14T09:05:17.456789Z",347 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"348 }349 ],350 "has_more": true,351 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="352}353```354