SPB Git

Repository Public

list.md 2.2 KB


# title: List Compliance Groups url: https://platform.claude.com/docs/en/api/compliance/groups/list

# List Compliance Groups

GET /v1/compliance/groups

List Compliance Groups

# Query parameters

  • limit: optional number

    Maximum results (default: 500, max: 1000)

    default: 500, maximum: 1000, minimum: 1

  • name_prefix: optional string

    Filter groups by name prefix

    default: ""

  • 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.

# Headers

  • "x-api-key": optional string

# Returns

  • data: array of object

    List of groups

    • id: string

      Group identifier (tagged ID)

    • created_at: string or null

      Group creation timestamp (RFC 3339)

      format: date-time

    • 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 (RFC 3339)

      format: date-time

  • 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

bash
curl https://api.anthropic.com/v1/compliance/groups \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

# Response (200)

json
{
  "data": [
    {
      "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
      "created_at": "2025-03-12T18:22:41.123456Z",
      "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.456789Z"
    }
  ],
  "has_more": true,
  "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
Files main
Menu

Theme