管理合规 API

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

通过 Compliance API 枚举您的父组织下的组织（其用户、角色和组），并读取每个组织的生效设置。

要启用 Compliance API，请参阅设置 Compliance API。

所需范围： Compliance Access Key（合规访问密钥）上的 read:compliance_org_data。用户和组成员端点则需要 read:compliance_user_data。

在 claude.ai 中创建的 Compliance Access Key（sk-ant-api01-...）是唯一被接受的密钥类型；请参阅设置 Compliance API来配置一个。使用 Admin API key（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 数组，外加用于分页的 has_more 和 next_page。当 has_more 为 true 时，将返回的 next_page 令牌原样作为下一个请求的 page 查询参数传回。有关 limit 和 page 参数的默认值和范围，请参阅 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_uuid`	Activity Feed、聊天和项目记录	相同的值；直接在这两个字段上进行联接
`organization_id`	Activity 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_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" \
  -H "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 角色分配的维度。典型的 eDiscovery 流程会列出一个或多个组织的用户，根据您自己的外部记录进行过滤，然后将得到的 ID 输入到聊天和项目查询中。

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

列出角色

列出 Compliance 角色端点返回在一个组织上定义的角色记录的分页列表，获取 Compliance 角色按 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" \
  -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_assigned 和 rbac_role_permission_added）；请参阅过滤活动。

列出组和成员

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

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

有关完整的组记录结构，请参阅列出 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": "[email protected]",
      "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_... 标识符相同。要获取成员的全名，请通过组织用户列表进行查找。

获取生效组织设置

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

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

在 2026 年 6 月 30 日之前，此端点需要单独的 read:compliance_org_settings 范围。该范围已停用：在创建密钥时不能再选择或授予它，并且仅携带已停用范围的密钥会返回 403 Forbidden。请改为创建带有 read:compliance_org_data 的新 Compliance Access Key。

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
    }
  ]
}

每行都带有 name、type 和 value；type 字段（boolean、integer、string_list、provisioning_mode 或 data_retention）告诉您 value 的结构。设置名称的完整列表以及每种类型的 value 模式，请参阅 API 参考中的获取生效组织设置。

api_keys 数组列出为您的父组织配置的每个 Compliance Access Key，因此无论您查询哪个关联组织，都会返回相同的列表。每个条目都带有密钥的 type（compliance_api_key）、id、name、scopes、is_active 标志、created_at 和 expires_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 中；使用此端点获取当前解析后的状态，使用 Activity Feed 审计谁在何时更改了什么。

后续步骤

Compliance 组织 API 参考

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

处理 Compliance API 错误

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

Was this page helpful?

管理合规 API

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

通过 Compliance API 枚举您的父组织下的组织（其用户、角色和组），并读取每个组织的生效设置。

要启用 Compliance API，请参阅设置 Compliance 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" \
  -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_uuid`	Activity Feed、聊天和项目记录	相同的值；直接在这两个字段上进行联接
`organization_id`	Activity Feed、聊天和项目记录	相同的组织，带 `org_` 前缀。在聊天和项目记录上已弃用；请改用 `organization_uuid`。
`organization_ids[]`	查询 Activity Feed和检索聊天和消息上的过滤器	接受 `uuid` 或带 `org_` 前缀的形式
`organization_id`	生效组织设置响应	相同的值，裸 UUID；此响应不使用 `organization_id` 在 Activity Feed、聊天和项目记录上所带的 `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" \
  -H "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"
}

列出角色

列出 Compliance 角色端点返回在一个组织上定义的角色记录的分页列表，获取 Compliance 角色按 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" \
  -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 组端点返回 RBAC 和 SCIM 配置的组的分页列表，获取 Compliance 组按 ID 返回一个组。列出 Compliance 组成员端点返回一个组的成员。

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

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": "[email protected]",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

获取生效组织设置

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"

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
    }
  ]
}

后续步骤

Compliance 组织 API 参考

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

处理 Compliance API 错误

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

Was this page helpful?

列出组织

列出组织用户

列出角色

列出组和成员

获取生效组织设置

后续步骤

列出组织

列出组织用户

列出角色

列出组和成员

获取生效组织设置

后续步骤

列出组织

列出组织用户

列出角色

列出组和成员

获取生效组织设置

后续步骤

列出组织

列出组织用户

列出角色

列出组和成员

获取生效组织设置

后续步骤