# Groups ## List Compliance Groups ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Compliance Group ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Group List Response ### Group Retrieve Response # Members ## List Compliance Group Members ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Member List Response
The whole hunk
348 lines, first recorded
/
lines
The first capture of this source. The page was already there, and this is what it said.
---
title: Groups
url: https://platform.claude.com/docs/en/api/compliance/groups
---
# Groups
## List Compliance Groups
**get** `/v1/compliance/groups`
List Compliance Groups
### Query Parameters
- `limit: optional number`
Maximum results (default: 500, max: 1000)
- `name_prefix: optional string`
Filter groups by name prefix
- `page: optional string`
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.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { id, created_at, description, 4 more }`
List of groups
- `id: string`
Group identifier (tagged ID)
- `created_at: string or null`
Group creation timestamp (ISO 8601)
- `description: string`
Group description
- `name: string`
Group name
- `roles: array of string or null`
Role IDs assigned to this group.
- `source_type: string`
How the group was created ('direct' or 'scim')
- `updated_at: string or null`
Group last-updated timestamp (ISO 8601)
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
Token to retrieve the next page. Use this as the 'page' parameter in your next request
### Example
```http
curl https://api.anthropic.com/v1/compliance/groups \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2025-03-12T18:22:41.123456",
"description": "All members of the engineering organization",
"name": "Engineering Team",
"roles": [
"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
],
"source_type": "scim",
"updated_at": "2025-03-14T09:05:17.456789"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
## Get Compliance Group
**get** `/v1/compliance/groups/{group_id}`
Get Compliance Group
### Path Parameters
- `group_id: string`
The group ID (tagged ID, e.g., rbac_group_abc123)
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `id: string`
Group identifier (tagged ID)
- `created_at: string or null`
Group creation timestamp (ISO 8601)
- `description: string`
Group description
- `name: string`
Group name
- `roles: array of string or null`
Role IDs assigned to this group.
- `source_type: string`
How the group was created ('direct' or 'scim')
- `updated_at: string or null`
Group last-updated timestamp (ISO 8601)
### Example
```http
curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response
```json
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2025-03-12T18:22:41.123456",
"description": "All members of the engineering organization",
"name": "Engineering Team",
"roles": [
"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
],
"source_type": "scim",
"updated_at": "2025-03-14T09:05:17.456789"
}
```
## Domain Types
### Group List Response
- `GroupListResponse object { id, created_at, description, 4 more }`
Group information for compliance responses.
- `id: string`
Group identifier (tagged ID)
- `created_at: string or null`
Group creation timestamp (ISO 8601)
- `description: string`
Group description
- `name: string`
Group name
- `roles: array of string or null`
Role IDs assigned to this group.
- `source_type: string`
How the group was created ('direct' or 'scim')
- `updated_at: string or null`
Group last-updated timestamp (ISO 8601)
### Group Retrieve Response
- `GroupRetrieveResponse object { id, created_at, description, 4 more }`
Group information for compliance responses.
- `id: string`
Group identifier (tagged ID)
- `created_at: string or null`
Group creation timestamp (ISO 8601)
- `description: string`
Group description
- `name: string`
Group name
- `roles: array of string or null`
Role IDs assigned to this group.
- `source_type: string`
How the group was created ('direct' or 'scim')
- `updated_at: string or null`
Group last-updated timestamp (ISO 8601)
# Members
## List Compliance Group Members
**get** `/v1/compliance/groups/{group_id}/members`
List Compliance Group Members
### Path Parameters
- `group_id: string`
The group ID (tagged ID, e.g., rbac_group_abc123)
### Query Parameters
- `limit: optional number`
Maximum results (default: 500, max: 1000)
- `page: optional string`
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.
### Header Parameters
- `"x-api-key": optional string`
### Returns
- `data: array of object { created_at, email, updated_at, user_id }`
List of group members
- `created_at: string or null`
Membership creation timestamp (ISO 8601)
- `email: string`
Member email address
- `updated_at: string or null`
Membership last-updated timestamp (ISO 8601)
- `user_id: string`
Member user identifier (tagged ID)
- `has_more: boolean`
Whether more records exist beyond the current result set
- `next_page: string or null`
Token to retrieve the next page. Use this as the 'page' parameter in your next request
Cut at 300 lines. The page has the rest.