Claude Platform Docs
管理合规 API

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

通过 Compliance API 枚举您的父组织下的各个组织(及其用户、角色和群组),并读取每个组织的有效设置。

本页上的端点公开了 Claude Enterprise 组织的目录侧信息:其关联组织、每个组织中的用户、每个组织上定义的角色,以及其"role-based access control"(基于角色的访问控制),即 RBAC 群组或"System for Cross-domain Identity Management"(跨域身份管理系统),即 SCIM 配置的群组及其成员。您可以使用它们为 eDiscovery 用户列表提供初始数据、构建报告仪表板,以及将群组成员资格与外部记录系统进行核对。覆盖父组织的 Compliance Access Key 会返回其下每个关联组织的数据,因此单个密钥即可访问整个组织树。有效设置端点是对目录的补充:它返回某一组织实际生效的数据隐私、安全和功能设置。

列出组织

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

以下调用列出您的父组织下的每个组织。响应是一个按 created_at 升序排序的组织记录 data 数组,外加用于分页的 has_morenext_page。当 has_moretrue 时,请在下一次请求中将返回的 next_page 令牌原样作为 page 查询参数传回。有关 limitpage 参数的默认值和范围,请参阅 API 参考中的列出组织

cURL
curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations" \
  -H "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"
    }
  ],
  "has_more": false,
  "next_page": null
}

uuid 字段是下游查找的规范标识符。下表将其与 Compliance API 中的其他组织标识符进行对应:

字段位置uuid 的关系
{org_uuid}本页上各按组织划分的端点的路径参数相同的值
organization_uuidActivity Feed、聊天、项目和会话记录相同的值;可直接在这两个字段上进行关联
organization_idActivity Feed、聊天和项目记录同一组织,带 org_ 前缀。在聊天和项目记录上已弃用;请改用 organization_uuid
organization_ids[]查询 Activity Feed检索聊天和消息以及远程会话列表上的筛选器(本地会话列表没有组织筛选器)接受 uuid 或带 org_ 前缀的形式
organization_id有效组织设置响应相同的值,裸 UUID;此响应使用 organization_id 在 Activity Feed、聊天和项目记录上所携带的带 org_ 前缀的形式

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

要跟踪组织成员资格随时间的变化,请定期重新列出此端点,每次遍历时沿 next_page 令牌翻阅每一页。Activity Feed 也会通过 org_deletion_requestedorg_deleted_via_bulkorg_parent_join_proposal_createdorg_join_proposal_decided 活动类型呈现成员资格事件;请参阅查询 Activity Feed

列出组织用户

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

此端点需要 read:compliance_user_data,而不是 read:compliance_org_data。如果您打算将 Compliance Access Key 用于目录枚举,请在创建时同时包含这两个作用域;否则调用会返回 403 Forbidden

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

结果按加入组织的日期升序排序。与 Activity Feed 的 before_id/after_id 游标(请参阅分页结果)不同,目录端点使用 next_page 令牌进行分页:当 has_moretrue 时,请在下一次请求中将 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" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY" \
  --data-urlencode "limit=500"
Response
{
  "data": [
    {
      "id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "full_name": "Priya Sharma",
      "email": "priya@example.com",
      "organization_role": "admin",
      "created_at": "2025-06-01T10:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "page_8aW5kZXgicG9zaXRpb25fdG9rZW5fOTE0"
}

此处返回的用户 ID 与查询 Activity Feedactor_ids[] 筛选器,以及检索聊天和消息远程会话列表上的 user_ids[] 筛选器所接受的 user_... 标识符相同;本地会话列表没有用户筛选器,因此请通过每个会话对象上的 user.id 来归属本地会话。organization_role 字段携带用户在所列组织中的内置成员级别(adminbillingclaude_code_userdevelopermanagedmembership_adminownerprimary_owneruser 之一),这是一个独立于列出角色所返回的任何自定义 RBAC 角色分配的维度。典型的 eDiscovery 流程会列出一个或多个组织的用户,根据您自己的外部记录进行筛选,然后将得到的 ID 输入到聊天和项目查询中。

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

列出角色

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

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

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

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/${org_uuid}/roles" \
  -H "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
}

有关完整的角色记录结构,请参阅列出 Compliance 角色响应模式。要列出当前授予某个角色的权限,请使用列出 Compliance 角色权限。要审计历史角色分配和权限变更,请通过 Activity Feed 查询 RBAC 活动类型(例如 rbac_role_assignedrbac_role_permission_added);请参阅筛选活动

列出群组和成员

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

群组列表和检索端点需要 read:compliance_org_data。成员端点需要 read:compliance_user_data。请在创建密钥时同时包含这两个作用域,以便端到端地遍历群组。两个列表端点都接受与组织用户端点相同的 limitpage 参数。

有关完整的群组记录结构,请参阅列出 Compliance 群组响应模式。roles 数组列出分配给该群组的角色 ID,与列出角色中的 ID 相匹配。source_type 是区分通过 claude.ai 手动创建的群组(direct)与通过 SCIM 从外部身份提供商同步的群组(scim)的判别字段。

列出群组,然后为每个群组列出其成员:

cURL
curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups" \
  -H "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" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "data": [
    {
      "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "email": "priya@example.com",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

有关完整的成员记录结构,请参阅列出 Compliance 群组成员响应模式。user_id 字段与 Activity Feed、聊天列表和远程会话列表所接受的 user_... 标识符相同;它也与本地会话对象以及用户拥有的远程会话对象上的 user.id 相匹配(代理拥有的远程会话则在 started_by_user.id 中携带人类用户的 ID)。要获取成员的全名,请通过组织用户列表进行查找。

获取有效组织设置

获取有效组织设置端点返回您的父组织下某一组织的生效设置:即在应用监管限制(例如 HIPAA)、功能可用性规则、组织类型默认值以及功能间依赖关系之后的强制执行状态,这可能与管理员所配置的内容不同。您可以使用它来证明保留窗口、内容脱敏、单点登录强制执行、IP 允许列表和会话时长控制与您记录在案的基线相符,而无需管理员 Console 访问权限。

此端点需要 read:compliance_org_data;不具备该作用域的密钥会返回 403 Forbidden。目标必须是父组织的关联组织之一:父组织本身不是有效目标。未知组织、不是有效 UUID 的组织 ID、位于您父组织树之外的组织,以及尚未获得此端点访问权限的父组织,都会返回相同的 404 Not Found,因此 404 不会透露某个组织是否存在。设置端点按父组织单独启用,与 Compliance API 的其余部分分开;如果每个请求都返回 404,请联系您的 Anthropic 代表。

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

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

响应是一个带类型的设置行列表,出现哪些行因组织而异:组织管理员无法更改的设置(因为它由 Anthropic 策略控制或对该组织不可用)会从列表中省略。请将缺失的行视为"此组织的管理员无法控制",而不是"关闭"。以下简略示例展示了响应可能包含的三行:

Response
{
  "type": "effective_organization_settings",
  "organization_id": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
  "settings": [
    {
      "name": "data_retention_periods",
      "type": "data_retention",
      "value": {
        "chat": {
          "type": "fixed",
          "timescale": "day",
          "duration": 90
        }
      }
    },
    {
      "name": "content_redaction_enabled",
      "type": "boolean",
      "value": true
    },
    {
      "name": "ip_allowlist_ip_ranges",
      "type": "string_list",
      "value": ["10.0.0.0/8", "203.0.113.0/24"]
    }
  ],
  "api_keys": [
    {
      "type": "compliance_api_key",
      "id": "apikey_01Hx7k2mP9nQ4rS6tU8vW0xY",
      "name": "Compliance Export Key",
      "scopes": ["read:compliance_activities", "read:compliance_org_data"],
      "is_active": true,
      "created_at": "2026-03-14T09:30:00Z",
      "created_by_id": "user_01Jz3a4bC5dE6fG7hI8jK9lM",
      "expires_at": null
    }
  ]
}

每一行都携带 nametypevaluetype 字段(booleanintegerstring_listprovisioning_modedata_retention)告诉您 value 的结构。设置名称的完整列表以及每种类型的 value 模式,请参阅 API 参考中的获取有效组织设置

api_keys 数组列出为您的父组织配置的每个 Compliance Access Key,因此无论您查询哪个关联组织,都会返回相同的列表。每个条目都携带密钥的 typecompliance_api_key)、idnamescopesis_active 标志、created_atexpires_at 时间戳,以及 created_by_id(创建该密钥的用户的 ID;可能为 null)。密钥的秘密值永远不会被返回。已停用的密钥会以 is_active: false 包含在内,以便您审查先前拥有访问权限的密钥;仅携带已停用的 read:compliance_org_settings 作用域的密钥也会保留在列表中,以便审计和清理时可见,即使该作用域不再授予访问权限。

顶层的 organization_id 是组织的裸 UUID:与组织列表中的 uuid 值相同,而不是 organization_id 在 Activity Feed、聊天和项目记录上所携带的带 org_ 前缀的形式(请参阅组织标识符表)。

各行反映的是强制执行状态,而不是最后存储的配置:例如,sso_provisioning_mode 仅在目录同步启用期间报告已配置的 SCIM 模式,ip_allowlist_enabled 仅在允许列表开启且至少有一个活跃范围时为 true,而 code_execution_network_egress_enabled 在代码执行关闭时始终为 false

响应反映读取时的状态;不会进行任何快照。对这些设置中大多数的更改会作为事件呈现在 Activity Feed 中;请使用此端点获取当前已解析的状态,并使用该信息流来审计谁在何时更改了什么。

后续步骤

每个组织、用户、角色、群组和设置端点的完整请求和响应模式。

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

Was this page helpful?