建立 Admin API 金鑰
為您的 Claude Console 或 Claude Enterprise 組織建立 Admin API 金鑰。
Admin API 金鑰可用於驗證本指南 Admin 章節中的每一個 API:Admin API、Analytics API、Compliance API、Spend Limits API、Usage and Cost API,以及 Rate Limits API。您不需要為每個 API 分別建立金鑰。唯一的例外是 Admin API 的 service-account、federation-issuer 與 federation-rule 端點,這些端點僅接受具有 org:admin 範圍的 OAuth bearer token。請參閱取得 OAuth bearer token。
您應在何處建立金鑰,取決於您的組織使用的是哪一項 Claude 產品。
您需要哪一種金鑰?
| 您的組織 | 建立金鑰的位置 | 金鑰前綴 | 誰可以建立 | 適用於 |
|---|---|---|---|---|
Claude Console(Claude Platform,platform.claude.com) | Claude Console > Settings > Admin keys | sk-ant-admin01-... | 具有 admin 角色的組織成員 | Admin API、Usage and Cost API、Rate Limits API、Claude Code Analytics API,以及 Compliance API 的 Activity Feed |
Claude Enterprise(claude.ai) | claude.ai > Organization settings > API | sk-ant-api01-... | 上層組織的主要擁有者(primary owner)(所有已連結的組織)。**組織擁有者(organization owner)**可以建立僅具有 Compliance API 範圍、且限定於其自身組織的金鑰 | 使用者管理(Admin API 的成員、邀請與群組端點)、Compliance API、Claude Enterprise Analytics API,以及 Spend Limits API,依您所選擇的範圍而定 |
在某一組織中建立的金鑰無法用於管理其他組織。如果您的公司同時使用 Claude Console 與 Claude Enterprise,請在兩者中各建立一把金鑰。
為 Claude Console 組織建立金鑰
以組織管理員身分登入
只有具有 admin 角色的組織成員可以建立 Admin API 金鑰。請參閱組織角色與權限。
開啟 Admin keys 設定
建立金鑰
點擊 Create key,為其命名,選擇金鑰到期時間,然後點擊 Create。Claude Console 金鑰沒有可選擇的範圍;每把金鑰都具有對所有接受 Admin API 金鑰之端點的完整存取權(本頁頂端所述的 service-account 與 federation 端點不接受 Admin API 金鑰)。
複製並儲存密鑰
複製所顯示的密鑰(以
sk-ant-admin01-開頭),並將其儲存於您的密鑰管理工具中。完整密鑰僅會顯示一次。
為 Claude Enterprise 組織建立金鑰
以主要擁有者或組織擁有者身分登入
Claude Enterprise 上層組織的主要擁有者可以建立能夠存取每個已連結組織的金鑰,或是限定於單一組織的金鑰。組織擁有者可以建立僅具有 Compliance API 範圍、且限定於其自身組織的金鑰。
開啟 API 設定
前往 claude.ai > Organization settings > API,並找到 Keys 區段。
點擊 + Create key
為金鑰命名,並從範圍表中選擇您需要的範圍。主要擁有者可以在單一金鑰上組合來自不同 API 的範圍(例如
read:analytics與read:spend_limits)。複製並儲存密鑰
複製所顯示的密鑰(以
sk-ant-api01-開頭),並將其儲存於您的密鑰管理工具中。完整密鑰僅會顯示一次。
為 Claude Enterprise 金鑰選擇範圍
當您建立 Claude Enterprise 金鑰時,請選擇您計畫呼叫的 API 所需的每一個範圍(scope)。範圍在建立時即固定;若日後要新增範圍,請建立新的金鑰。
| 若要呼叫…… | 請選擇這些範圍 |
|---|---|
| Admin API 使用者管理:列出並查詢成員與邀請;讀取自訂角色及其權限 | read:members |
| Admin API 使用者管理:變更成員角色、移除成員、建立與撤回邀請 | write:members |
| Admin API 使用者管理:讀取群組及其成員 | read:rbac_groups |
| Admin API 使用者管理:建立、重新命名與刪除群組;新增與移除群組成員;在建立邀請時指派群組 | write:rbac_groups |
| Spend Limits API:讀取成員的有效支出限額與提高限額請求 | read:spend_limits |
| Spend Limits API:設定或清除個別使用者的支出限額;核准或拒絕提高限額請求 | write:spend_limits |
| Claude Enterprise Analytics API:參與度、採用率、成本與使用量報告 | read:analytics |
| Compliance API Activity Feed:全組織的活動事件 | read:compliance_activities |
| Compliance API 聊天、檔案與專案端點以及 Compliance API 工作階段端點:讀取聊天、檔案、專案、工作階段逐字稿,以及組織使用者 | read:compliance_user_data |
| Compliance API 聊天、檔案與專案端點:刪除聊天、檔案與專案 | delete:compliance_user_data |
| Compliance API 組織端點:讀取組織中繼資料與有效設定 | read:compliance_org_data |
| Admin API 使用者管理讀取端點以及每一個 Compliance API 讀取端點,使用單一唯讀範圍(適用於安全稽核整合;不包含 Spend Limits 或 Analytics API) | read:org_audit |
在使用具有這些範圍的金鑰之前,必須先為您的組織啟用 Compliance 與 Analytics API。請參閱設定 Compliance API 以及取得 Claude Enterprise Analytics API 的存取權。
使用金鑰
在每個請求的 x-api-key 標頭中傳遞金鑰。完整的請求範例請參閱各 API 的文件。
超出金鑰範圍的呼叫會回傳 403 Forbidden,並附帶一則訊息,列出該金鑰所具有的範圍以及該端點所需的範圍。
後續步驟
管理組織成員、工作區與 API 金鑰。
為您的 Claude Enterprise 組織設定個別成員的支出限額,並審核提高限額請求。
產出 Claude Code 生產力或 Claude Enterprise 參與度與採用率的報告。
稽核活動,並擷取或刪除整個組織中的使用者內容。
Was this page helpful?