SPB Git

Repository Public

list.md 2.2 KB 110 lines markdown

1---2title: List Compliance Groups3url: https://platform.claude.com/docs/en/api/compliance/groups/list4---56# List Compliance Groups78**GET** `/v1/compliance/groups`910List Compliance Groups1112## Query parameters1314- `limit: optional number`1516  Maximum results (default: 500, max: 1000)1718  default: 500, maximum: 1000, minimum: 11920- `name_prefix: optional string`2122  Filter groups by name prefix2324  default: ""2526- `page: optional string`2728  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.2930## Headers3132- `"x-api-key": optional string`3334## Returns3536- `data: array of object`3738  List of groups3940  - `id: string`4142    Group identifier (tagged ID)4344  - `created_at: string or null`4546    Group creation timestamp (RFC 3339)4748    format: date-time4950  - `description: string`5152    Group description5354  - `name: string`5556    Group name5758  - `roles: array of string or null`5960    Role IDs assigned to this group.6162  - `source_type: string`6364    How the group was created ('direct' or 'scim')6566  - `updated_at: string or null`6768    Group last-updated timestamp (RFC 3339)6970    format: date-time7172- `has_more: boolean`7374  Whether more records exist beyond the current result set7576- `next_page: string or null`7778  Token to retrieve the next page. Use this as the 'page' parameter in your next request7980## Example8182```bash83curl https://api.anthropic.com/v1/compliance/groups \84    -H 'anthropic-version: 2023-06-01' \85    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"86```8788### Response (200)8990```json91{92  "data": [93    {94      "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",95      "created_at": "2025-03-12T18:22:41.123456Z",96      "description": "All members of the engineering organization",97      "name": "Engineering Team",98      "roles": [99        "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",100        "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"101      ],102      "source_type": "scim",103      "updated_at": "2025-03-14T09:05:17.456789Z"104    }105  ],106  "has_more": true,107  "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="108}109```110
Files main
Menu

Theme