Compliance API 需申請後才能啟用。Claude Enterprise 組織可存取完整的 API;Claude Console 組織僅能存取 Activity Feed。本頁說明如何申請存取權限及建立 API 金鑰。
所需角色: 組織管理員(Claude Console)或主要擁有者(claude.ai)。
Compliance API 使用兩種金鑰類型,您應建立哪一種取決於您的組織使用哪個 Claude 產品。主要擁有者在 claude.ai 中建立 Compliance Access Key;這些金鑰可解鎖完整的 Compliance API。組織管理員在 Claude Console 中建立 Admin API 金鑰;這些金鑰僅能解鎖 Activity Feed。
| 金鑰類型 | 建立位置 | 用途 | 是否適用於 Compliance API? |
|---|---|---|---|
Compliance Access Key(sk-ant-api01-...) | claude.ai > Organization settings > API | Activity Feed、對話、檔案、專案、使用者及組織中繼資料 | 是(所有端點) |
Admin API 金鑰(sk-ant-admin01-...) | Claude Console > Settings > Admin keys | Admin API 及 Compliance API Activity Feed | 僅限 Activity Feed |
| Analytics API 金鑰 | claude.ai > Analytics > API keys | Claude Enterprise Analytics API | 否 |
Claude API 金鑰(sk-ant-api03-...) | Claude Console > Settings > API keys | 透過 Claude API 呼叫 Claude 模型 | 否 |
Claude Enterprise 租戶擁有一個父組織,為其下的每個工作負載組織集中管理身分識別、SSO 和 SCIM。這些工作負載組織即為父組織的連結組織。
Claude Enterprise 父組織不會出現在 Claude Console(platform.claude.com)中。 父組織不承載任何工作負載、Claude API 金鑰或 Admin API 金鑰。請在 claude.ai 的 Organization settings 中建立 Compliance Access Key,而非在 Claude Console 中。
請聯絡您的 Anthropic 代表以申請存取權限。啟用作業在父組織層級進行,並會向下套用至每個連結組織,包括 claude.ai 和 Claude Console。啟用後的變化取決於您的組織使用哪個 Claude 產品。
Anthropic 為您的父組織啟用 Compliance API 後,主要擁有者即可從 claude.ai > Organization settings > API 的 Keys 區段建立 Compliance Access Key。
Anthropic 為您的父組織啟用 Compliance API 後,此後建立的 Admin API 金鑰將帶有 read:compliance_activities 範圍。啟用前建立的 Admin API 金鑰仍可繼續用於 Admin API,但使用這些金鑰呼叫 Activity Feed 會傳回 403 Forbidden;請建立新的 Admin API 金鑰以取得該範圍。
必須先為您的 claude.ai 父組織啟用 Compliance API,才能建立 Compliance Access Key。
具有 read:compliance_user_data 的 Compliance Access Key 可讀取每個連結組織中的所有對話、檔案和專案,包括主要擁有者尚未看過的內容。具有 delete:compliance_user_data 的金鑰可永久刪除該內容。請將 Compliance Access Key 視為正式環境資料庫憑證:將其儲存在密鑰管理工具中,切勿存放於原始碼控制或 SIEM 轉送器設定中。
以主要擁有者身分登入
只有父組織的主要擁有者才能建立 Compliance Access Key。如果看不到下一步所述的 API 頁面,或建立金鑰時無法選擇 compliance 範圍,則表示您不是主要擁有者,或您的組織尚未啟用 Compliance API(請參閱申請 Compliance API 存取權限)。
開啟 API 設定
前往 claude.ai > Organization settings > API 並找到 Keys 區段。
建立金鑰
按一下 Create key,為金鑰命名,並從下表中選取一或多個範圍。按一下 Create。
| 範圍 | 授予的權限 |
|---|---|
read:compliance_activities | 讀取父組織及所有連結組織的 Activity Feed |
read:compliance_user_data | 讀取使用者對話、訊息、檔案、專案、組織使用者及群組成員 |
delete:compliance_user_data | 刪除使用者對話、檔案及專案 |
read:compliance_org_data | 讀取組織中繼資料(名稱、類型、角色及群組)。使用者清單及群組成員資格需要 read:compliance_user_data。 |
請選擇您的整合所需的最小範圍集合:
read:compliance_activities。delete:compliance_user_data。Compliance Access Key 的範圍在建立後即無法變更。若要變更範圍,請建立具有所需範圍的新金鑰,然後刪除舊金鑰。
複製並儲存密鑰
複製顯示的密鑰(以 sk-ant-api01- 開頭)並將其儲存在您的密鑰管理工具中。完整的密鑰只會顯示一次。
匯出金鑰以供本指南中的範例使用
將金鑰設定為環境變數,以便本指南中的 shell 範例可以讀取:
export ANTHROPIC_COMPLIANCE_ACCESS_KEY=sk-ant-api01-...必須先為您的 Claude Console 組織啟用 Compliance API,Admin API 金鑰才能呼叫 Activity Feed。
以組織管理員身分登入
只有具有 admin 角色的組織成員才能建立 Admin API 金鑰。完整的角色清單請參閱組織角色與權限。
開啟 Admin keys 設定
建立金鑰
按一下 Create key,為金鑰命名,然後按一下 Create。
複製並儲存密鑰
複製顯示的密鑰(以 sk-ant-admin01- 開頭)並將其儲存在您的密鑰管理工具中。完整的密鑰只會顯示一次。
匯出金鑰以供 Activity Feed 使用
將金鑰設定為環境變數:
export ANTHROPIC_ADMIN_KEY=sk-ant-admin01-...使用不同的變數名稱可避免在您同時配置兩種金鑰時,Admin API 金鑰覆寫 Compliance Access Key。本指南中的 cURL 範例從 $ANTHROPIC_COMPLIANCE_ACCESS_KEY 讀取金鑰;使用 Admin API 金鑰呼叫 Activity Feed 時,請替換為 $ANTHROPIC_ADMIN_KEY。
只有在建立金鑰之前已為組織啟用 Compliance API 的情況下,Admin API 金鑰才會帶有 read:compliance_activities 範圍;請參閱啟用後:Claude Console 組織。這些金鑰無法被授予任何其他 Compliance API 範圍,因此呼叫 Activity Feed 以外的任何端點都會傳回 403 Forbidden。
關於同一金鑰在管理 Claude Console 組織中的角色,請參閱 Admin API。
若要檢查您已持有金鑰的範圍,請使用下列其中一種方式。
sk-ant-admin01- 是 Admin API 金鑰(僅帶有 read:compliance_activities,且受前一節所述的啟用時間點限制)。sk-ant-api01- 是 Compliance Access Key;其範圍為您在建立時所選取的子集。Missing required scopes. Got: [<scopes the key carries>] Needed: [<scopes the endpoint requires>] 的訊息。完整的錯誤目錄請參閱處理 Compliance API 錯誤。{
"error": {
"type": "permission_error",
"message": "Missing required scopes. Got: ['read:compliance_activities'] Needed: ['read:compliance_user_data']"
}
}從建立 Compliance Access Key 的同一個 Keys 表格中刪除該金鑰:前往 claude.ai > Organization settings > API。從 Claude Console > Settings > Admin keys 刪除 Admin API 金鑰。
刪除金鑰會在下一次請求時生效:沒有寬限期。Compliance Access Key 不會自行過期。
若要在不中斷服務的情況下輪替金鑰:
輪替前儲存的分頁游標仍然有效:游標的範圍限定於組織,而非金鑰。
如果 Compliance Access Key 外洩,請立即刪除該金鑰,稽核 Activity Feed 中由遭洩漏金鑰產生的 compliance_api_accessed 活動,並輪替該外洩金鑰可能觸及的任何下游憑證。傳遞 activity_types[]=compliance_api_accessed 以限定查詢範圍,然後在您的用戶端中,保留 actor.type 為 api_actor 且 actor.api_key_id 與遭洩漏金鑰相符的活動;actor 結構描述請參閱了解 Activity 物件。
使用任何具有 read:compliance_activities 的金鑰讀取組織範圍的活動事件。
使用具有 read:compliance_user_data 的 Compliance Access Key 擷取 claude.ai 內容,並使用 delete:compliance_user_data 刪除內容。
Was this page helpful?