管理合規 API

列出組織、使用者、角色和群組

透過 Compliance API 列舉您父組織下的組織、其使用者、角色和群組。

Compliance API 需申請後方可啟用。Claude Enterprise 組織可存取完整的 API；Claude Console 組織僅可存取活動動態。請參閱取得 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 金鑰（sk-ant-admin01-...）進行驗證的呼叫會回傳 403 Forbidden。

本頁面的端點公開 Claude Enterprise 組織的目錄面向：其連結的組織、每個組織中的使用者、每個組織上定義的角色，以及其「role-based access control」（基於角色的存取控制），即 RBAC，或「System for Cross-domain Identity Management」（跨網域身分管理系統），即 SCIM 所配置的群組及其成員。使用這些端點來建立 eDiscovery 使用者清單、建置報表儀表板，以及將群組成員資格與外部記錄系統進行比對。Compliance Access Key 綁定至父組織，並回傳其下每個連結組織的資料，因此單一金鑰即可涵蓋整個樹狀結構。

列出組織

List organizations 端點會回傳金鑰所綁定之父組織下的每個組織。

以下呼叫會列出您父組織下的每個組織。回應是單一 data 陣列，其中包含依 created_at 遞增排序的組織記錄。此端點在單次呼叫中最多回傳 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。

列出組織使用者

List organization users 端點會回傳單一組織的分頁使用者記錄清單。

此端點需要 read:compliance_user_data，而非 read:compliance_org_data。當您打算將 Compliance Access Key 用於目錄列舉時，請在建立時同時包含這兩個範圍；否則呼叫會回傳 403 Forbidden。

請參閱 API 參考中的 List organization users，以了解 limit 和 page 查詢參數的預設值和範圍。

結果依組織加入日期遞增排序。與 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 角色指派的另一個維度。典型的 eDiscovery 流程會列出一個或多個組織的使用者，根據您自己的外部記錄進行篩選，然後將產生的 ID 輸入對話和專案查詢。

使用者只有在是組織的活躍成員時才會出現在此處。被移除的使用者會立即從清單中刪除。其歷史活動在完整保留期間內仍可透過 Activity Feed 查詢，並以相同的 user_... ID 建立索引。

列出角色

List Compliance Roles 端點會回傳單一組織上定義的分頁角色記錄清單，而 Get Compliance Role 會依 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
}

請參閱 List Compliance Roles 回應結構描述，以了解完整的角色記錄格式。若要列出目前授予某個角色的權限，請使用 List Compliance Role Permissions。若要稽核歷史角色指派和權限變更，請透過 Activity Feed 查詢 RBAC 活動類型（例如 rbac_role_assigned 和 rbac_role_permission_added）；請參閱篩選活動。

列出群組和成員

List Compliance Groups 端點會回傳 RBAC 和 SCIM 配置群組的分頁清單，而 Get Compliance Group 會依 ID 回傳單一群組。List Compliance Group Members 端點會回傳單一群組的成員。

群組列表和擷取端點需要 read:compliance_org_data。成員端點需要 read:compliance_user_data。建立同時具有這兩個範圍的金鑰，以便完整遍歷群組。兩個列表端點都接受與列出組織使用者相同的 limit 和 page 參數。

請參閱 List Compliance Groups 回應結構描述，以了解完整的群組記錄格式。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
}

請參閱 List Compliance Group Members 回應結構描述，以了解完整的成員記錄格式。user_id 欄位與 Activity Feed 和對話清單所接受的 user_... 識別碼相同。若要取得成員的全名，請透過組織使用者清單進行查詢。

後續步驟

Compliance 組織 API 參考

每個組織、使用者、角色和群組端點的完整請求和回應結構描述。

處理 Compliance API 錯誤

逐字錯誤酬載及每個錯誤的修正方法。

Was this page helpful?

管理合規 API

列出組織、使用者、角色和群組

透過 Compliance API 列舉您父組織下的組織、其使用者、角色和群組。

Compliance API 需申請後方可啟用。Claude Enterprise 組織可存取完整的 API；Claude Console 組織僅可存取活動動態。請參閱取得 Compliance API 存取權限。

所需範圍： Compliance Access Key 上的 read:compliance_org_data。使用者和群組成員端點則需要 read:compliance_user_data。

列出組織

List organizations 端點會回傳金鑰所綁定之父組織下的每個組織。

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_ 前綴的形式。

列出組織使用者

List organization users 端點會回傳單一組織的分頁使用者記錄清單。

請參閱 API 參考中的 List organization users，以了解 limit 和 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"
}

列出角色

List Compliance Roles 端點會回傳單一組織上定義的分頁角色記錄清單，而 Get Compliance Role 會依 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
}

列出群組和成員

先列出群組，然後針對每個群組列出其成員：

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
}

後續步驟

Compliance 組織 API 參考

每個組織、使用者、角色和群組端點的完整請求和回應結構描述。

處理 Compliance API 錯誤

逐字錯誤酬載及每個錯誤的修正方法。

Was this page helpful?