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
  
  Group creation timestamp (ISO 8601)
- description: string
  
  Group description
- name: string
  
  Group name
- roles: array of string
  
  Role IDs assigned to this group.
- source_type: string
  
  How the group was created ('direct' or 'scim')
- updated_at: string
  
  Group last-updated timestamp (ISO 8601)
has_more: boolean

Whether more records exist beyond the current result set
next_page: string

Token to retrieve the next page. Use this as the 'page' parameter in your next request

Example

curl https://api.anthropic.com/v1/compliance/groups \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "id": "id",
      "created_at": "created_at",
      "description": "description",
      "name": "name",
      "roles": [
        "string"
      ],
      "source_type": "source_type",
      "updated_at": "updated_at"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

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

Group creation timestamp (ISO 8601)
description: string

Group description
name: string

Group name
roles: array of string

Role IDs assigned to this group.
source_type: string

How the group was created ('direct' or 'scim')
updated_at: string

Group last-updated timestamp (ISO 8601)

Example

curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "created_at": "created_at",
  "description": "description",
  "name": "name",
  "roles": [
    "string"
  ],
  "source_type": "source_type",
  "updated_at": "updated_at"
}

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
  
  Group creation timestamp (ISO 8601)
- description: string
  
  Group description
- name: string
  
  Group name
- roles: array of string
  
  Role IDs assigned to this group.
- source_type: string
  
  How the group was created ('direct' or 'scim')
- updated_at: string
  
  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
  
  Group creation timestamp (ISO 8601)
- description: string
  
  Group description
- name: string
  
  Group name
- roles: array of string
  
  Role IDs assigned to this group.
- source_type: string
  
  How the group was created ('direct' or 'scim')
- updated_at: string
  
  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
  
  Membership creation timestamp (ISO 8601)
- email: string
  
  Member email address
- updated_at: string
  
  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

Token to retrieve the next page. Use this as the 'page' parameter in your next request

Example

curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "created_at": "created_at",
      "email": "email",
      "updated_at": "updated_at",
      "user_id": "user_id"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

Domain Types

Member List Response

MemberListResponse object { created_at, email, updated_at, user_id }

Group member for compliance responses.
- created_at: string
  
  Membership creation timestamp (ISO 8601)
- email: string
  
  Member email address
- updated_at: string
  
  Membership last-updated timestamp (ISO 8601)
- user_id: string
  
  Member user identifier (tagged ID)