管理合规 API

列出组织、用户、角色和群组

通过 Compliance API 枚举父组织下的组织、其用户、角色和群组。

合规 API 需申请后方可启用。Claude Enterprise 组织可访问完整的 API；Claude Console 组织仅可访问活动信息流。请参阅获取合规 API 访问权限。

所需权限范围： Compliance Access Key 上的 read:compliance_org_data。用户和群组成员端点则需要 read:compliance_user_data。

在 claude.ai 中创建的 Compliance Access Key（sk-ant-api01-...）是唯一被接受的密钥类型；请参阅获取 Compliance API 访问权限以配置密钥。使用 Admin API 密钥（sk-ant-admin01-...）进行身份验证的调用将返回 403 Forbidden。

本页面上的端点公开了 Claude Enterprise 组织的目录信息：其关联的组织、每个组织中的用户、每个组织上定义的角色，以及其基于角色的访问控制（"role-based access control"，即 RBAC）或通过 SCIM（"System for Cross-domain Identity Management"，跨域身份管理系统）配置的群组及其成员。您可以使用这些端点来初始化电子取证（eDiscovery）用户列表、构建报告仪表板，以及将群组成员资格与外部记录系统进行核对。Compliance Access Key 绑定到父组织，并返回其下所有关联组织的数据，因此单个密钥即可覆盖整个组织树。

列出组织

列出组织端点返回密钥所绑定的父组织下的每个组织。

以下调用列出您的父组织下的每个组织。响应是一个按 created_at 升序排序的组织记录 data 数组。该端点在一次调用中最多返回 1,000 个组织；如果您的组织树超过该数量，则会返回 500 错误。

cURL

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "uuid": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
      "name": "Acme Engineering",
      "created_at": "2025-06-01T10:00:00Z"
    },
    {
      "uuid": "5a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "name": "Acme Legal",
      "created_at": "2025-07-15T14:30:00Z"
    }
  ]
}

uuid 字段是用于下游查询的规范标识符。下表将其与 Compliance API 中的其他组织标识符进行了映射：

字段	位置	与 `uuid` 的关系
`{org_uuid}`	本页面上各组织端点的路径参数	相同的值
`organization_uuid`	Activity Feed、聊天和项目记录	相同的值；可直接通过这两个字段进行关联
`organization_id`	Activity Feed、聊天和项目记录	同一组织，带 `org_` 前缀。在聊天和项目记录中已弃用；请改用 `organization_uuid`。
`organization_ids[]`	查询 Activity Feed 和检索聊天和消息上的过滤器	接受 `uuid` 或带 `org_` 前缀的形式

大多数其他 Anthropic API 使用带 org_ 前缀的形式。

如果您的组织树超过 1,000 个组织的上限，请联系 Anthropic 支持团队。要跟踪组织成员资格随时间的变化，请定期重新调用此端点。Activity Feed 也会通过 org_deletion_requested、org_deleted_via_bulk、org_parent_join_proposal_created 和 org_join_proposal_decided 活动类型显示成员资格事件；请参阅查询 Activity Feed。

列出组织用户

列出组织用户端点返回一个组织的用户记录分页列表。

此端点需要 read:compliance_user_data，而非 read:compliance_org_data。如果您打算将 Compliance Access Key 用于目录枚举，请在创建时同时包含这两个权限范围；否则调用将返回 403 Forbidden。

有关 limit 和 page 查询参数的默认值和范围，请参阅 API 参考中的列出组织用户。

结果按加入组织的日期升序排序。与 Activity Feed 的 before_id/after_id 游标（参见对结果进行分页）不同，目录端点使用 next_page 令牌进行分页：当 has_more 为 true 时，将 next_page 原样作为下一个请求的 page 查询参数传回。

cURL

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/users" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY" \
  --data-urlencode "limit=500"

Response

{
  "data": [
    {
      "id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "full_name": "Priya Sharma",
      "email": "[email protected]",
      "organization_role": "admin",
      "created_at": "2025-06-01T10:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "page_8aW5kZXgicG9zaXRpb25fdG9rZW5fOTE0"
}

此处返回的用户 ID 与查询 Activity Feed 的 actor_ids[] 过滤器和检索聊天和消息的 user_ids[] 过滤器所接受的 user_... 标识符相同。organization_role 字段表示用户在所列组织中的内置成员级别（admin、billing、claude_code_user、developer、managed、membership_admin、owner、primary_owner 或 user 之一），这是一个独立于列出角色返回的任何自定义 RBAC 角色分配的维度。典型的电子取证流程是列出一个或多个组织的用户，根据您自己的外部记录进行过滤，然后将生成的 ID 输入到聊天和项目查询中。

用户只有在作为组织的活跃成员时才会出现在此列表中。被移除的用户会立即从列表中删除。他们的历史活动在整个保留期内仍可通过 Activity Feed 查询，并以相同的 user_... ID 进行索引。

列出角色

列出合规角色端点返回一个组织上定义的角色记录分页列表，获取合规角色则按 ID 返回单个角色。

这两个角色端点都需要 read:compliance_org_data。列表端点接受与列出组织用户相同的 limit 和 page 参数。

cURL

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/${org_uuid}/roles" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "id": "rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh",
      "name": "Compliance Reviewer",
      "description": "Read-only access to chat and project content for legal review.",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

有关完整的角色记录结构，请参阅列出合规角色响应架构。要列出当前授予某个角色的权限，请使用列出合规角色权限。要审计历史角色分配和权限变更，请通过 Activity Feed 查询 RBAC 活动类型（例如 rbac_role_assigned 和 rbac_role_permission_added）；请参阅过滤活动。

列出群组和成员

列出合规群组端点返回 RBAC 和 SCIM 配置的群组的分页列表，获取合规群组则按 ID 返回单个群组。列出合规群组成员端点返回一个群组的成员。

群组列表和检索端点需要 read:compliance_org_data。成员端点需要 read:compliance_user_data。请创建同时包含这两个权限范围的密钥，以便端到端遍历群组。两个列表端点都接受与列出组织用户相同的 limit 和 page 参数。

有关完整的群组记录结构，请参阅列出合规群组响应架构。roles 数组列出分配给该群组的角色 ID，与列出角色返回的 ID 相匹配。source_type 用于区分通过 claude.ai 手动创建的群组（direct）和通过 SCIM 从外部身份提供商同步的群组（scim）。

先列出群组，然后为每个群组列出其成员：

cURL

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "id": "rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK",
      "name": "Engineering",
      "description": "Engineering team members",
      "source_type": "scim",
      "roles": ["rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh"],
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

对于每个群组 ID，列出其成员：

cURL

group_id="rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups/$group_id/members" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "email": "[email protected]",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

有关完整的成员记录结构，请参阅列出合规群组成员响应架构。user_id 字段与 Activity Feed 和聊天列表所接受的 user_... 标识符相同。要获取成员的全名，请通过组织用户列表进行查找。

后续步骤

合规组织 API 参考

每个组织、用户、角色和群组端点的完整请求和响应架构。

处理 Compliance API 错误

逐字的错误负载及每种错误的修复方法。

Was this page helpful?

管理合规 API

列出组织、用户、角色和群组

通过 Compliance API 枚举父组织下的组织、其用户、角色和群组。

合规 API 需申请后方可启用。Claude Enterprise 组织可访问完整的 API；Claude Console 组织仅可访问活动信息流。请参阅获取合规 API 访问权限。

所需权限范围： Compliance Access Key 上的 read:compliance_org_data。用户和群组成员端点则需要 read:compliance_user_data。

列出组织

列出组织端点返回密钥所绑定的父组织下的每个组织。

cURL

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "uuid": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
      "name": "Acme Engineering",
      "created_at": "2025-06-01T10:00:00Z"
    },
    {
      "uuid": "5a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "name": "Acme Legal",
      "created_at": "2025-07-15T14:30:00Z"
    }
  ]
}

uuid 字段是用于下游查询的规范标识符。下表将其与 Compliance API 中的其他组织标识符进行了映射：

字段	位置	与 `uuid` 的关系
`{org_uuid}`	本页面上各组织端点的路径参数	相同的值
`organization_uuid`	Activity Feed、聊天和项目记录	相同的值；可直接通过这两个字段进行关联
`organization_id`	Activity Feed、聊天和项目记录	同一组织，带 `org_` 前缀。在聊天和项目记录中已弃用；请改用 `organization_uuid`。
`organization_ids[]`	查询 Activity Feed 和检索聊天和消息上的过滤器	接受 `uuid` 或带 `org_` 前缀的形式

大多数其他 Anthropic API 使用带 org_ 前缀的形式。

列出组织用户

列出组织用户端点返回一个组织的用户记录分页列表。

有关 limit 和 page 查询参数的默认值和范围，请参阅 API 参考中的列出组织用户。

cURL

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/users" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY" \
  --data-urlencode "limit=500"

Response

{
  "data": [
    {
      "id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "full_name": "Priya Sharma",
      "email": "[email protected]",
      "organization_role": "admin",
      "created_at": "2025-06-01T10:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "page_8aW5kZXgicG9zaXRpb25fdG9rZW5fOTE0"
}

列出角色

列出合规角色端点返回一个组织上定义的角色记录分页列表，获取合规角色则按 ID 返回单个角色。

这两个角色端点都需要 read:compliance_org_data。列表端点接受与列出组织用户相同的 limit 和 page 参数。

cURL

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/${org_uuid}/roles" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "id": "rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh",
      "name": "Compliance Reviewer",
      "description": "Read-only access to chat and project content for legal review.",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

列出群组和成员

列出合规群组端点返回 RBAC 和 SCIM 配置的群组的分页列表，获取合规群组则按 ID 返回单个群组。列出合规群组成员端点返回一个群组的成员。

先列出群组，然后为每个群组列出其成员：

cURL

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "id": "rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK",
      "name": "Engineering",
      "description": "Engineering team members",
      "source_type": "scim",
      "roles": ["rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh"],
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

对于每个群组 ID，列出其成员：

cURL

group_id="rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups/$group_id/members" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Response

{
  "data": [
    {
      "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "email": "[email protected]",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

后续步骤

合规组织 API 参考

每个组织、用户、角色和群组端点的完整请求和响应架构。

处理 Compliance API 错误

逐字的错误负载及每种错误的修复方法。

Was this page helpful?