org:admin OAuth 權杖,透過 Admin API 以程式化方式管理組織成員、工作區、邀請和 API 金鑰。Admin API 不適用於個人帳戶。 若要與團隊成員協作並新增成員,請在 Console → Settings → Organization 中設定您的組織。
Admin API 讓您能以程式化方式管理組織的資源,包括組織成員、工作區和 API 金鑰。這為原本需要在 Claude Console 中手動設定的管理任務提供了程式化控制。
Admin API 需要特殊存取權限
Admin API 接受兩種憑證:
x-api-key 標頭中傳送的 Admin API 金鑰(以 sk-ant-admin... 開頭)。只有具有 admin 角色的組織成員才能建立。請參閱建立 Admin API 金鑰。authorization: Bearer 標頭中傳送、具有 org:admin 範圍的 OAuth bearer 權杖。只有具有 admin、owner 或 primary owner 角色的成員才能取得。請參閱取得 OAuth bearer 權杖。Claude Platform on AWS: 大部分的 Admin API 在 Claude Platform on AWS 上不可用。工作區端點(/v1/organizations/workspaces 上的建立、取得、列出、更新和封存)可以使用。其他端點包括組織成員、工作區成員、邀請、API 金鑰、使用量報告、成本報告和速率限制報告則不可用。詳情請參閱 Claude Platform on AWS。
使用任一憑證進行驗證。Admin API 金鑰涵蓋大多數端點;服務帳戶、聯合發行者和聯合規則端點僅接受 org:admin OAuth 權杖。以下範例以兩種方式呼叫組織資訊端點。
使用 ant CLI 在專用設定檔下登入,並請求 org:admin 範圍(請參閱管理員存取),然後匯出 bearer 權杖。專用設定檔可避免您的日常指令以提升的存取權限執行:
ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token)互動式權杖的有效期很短;如果請求開始回傳 401,請重新執行 export 指令,它會自動重新整理權杖。
使用匯出的權杖呼叫 Admin API:
curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
--header "anthropic-version: 2023-06-01" \
--header "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"org:admin 權杖授予對整個組織的存取權限,無論底層設定檔或聯合規則綁定到哪個工作區。
對於 CI 和其他非互動式工作負載,請使用 Workload Identity Federation 產生權杖,而不是以互動方式登入。請參閱使用 Admin API 管理 WIF。
若要為您的組織類型建立 Admin API 金鑰,請參閱建立 Admin API 金鑰。
curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"當您使用 Admin API 時:
org:admin OAuth 權杖;不接受 Admin API 金鑰)這對以下情況很有用:
有五種組織層級的角色。更多詳細資訊請參閱 API Console 角色和權限文章。
| 角色 | 權限 |
|---|---|
| user | 可以使用 Workbench |
| claude_code_user | 可以使用 Workbench 和 Claude Code |
| developer | 可以使用 Workbench 和管理 API 金鑰 |
| billing | 可以使用 Workbench 和管理帳務詳細資訊 |
| admin | 可以執行上述所有操作,並管理使用者 |
組織的 owner 和 primary owner 擁有所有 admin 權限,並且還可以管理 admin。本頁中所有對 admin 角色的引用也適用於 owner 和 primary owner。
您可以列出組織成員、更新成員角色和移除成員。
# 列出組織成員
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# 更新成員角色
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "content-type: application/json" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{"role": "developer"}'
# 移除成員
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"您可以邀請使用者加入組織並管理這些邀請。
# 建立邀請
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
--header "anthropic-version: 2023-06-01" \
--header "content-type: application/json" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"email": "[email protected]",
"role": "developer"
}'
# 列出邀請
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# 刪除邀請
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"有關工作區的完整指南,包括 Console 和 API 範例,請參閱工作區。
# 將成員加入工作區
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
--header "anthropic-version: 2023-06-01" \
--header "content-type: application/json" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"user_id": "user_xxx",
"workspace_role": "workspace_developer"
}'
# 列出工作區成員
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# 更新成員角色
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "content-type: application/json" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"workspace_role": "workspace_admin"
}'
# 從工作區移除成員
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"監控和管理 API 金鑰。回應中的每個金鑰都包含其 expires_at 時間戳記(沒有到期時間的金鑰則為 null):
# 列出 API 金鑰
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# 更新 API 金鑰
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
--header "anthropic-version: 2023-06-01" \
--header "content-type: application/json" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"status": "inactive",
"name": "New Key Name"
}'建立和管理服務帳戶(svac_...),即 Workload Identity Federation 權杖所代表的非人類身分。服務帳戶、聯合發行者或聯合規則端點不接受 Admin API 金鑰;請使用 org:admin OAuth 權杖。請參閱使用 Admin API 管理 WIF。
註冊 OIDC 身分提供者(fdis_...),其權杖可以為您的組織聲明工作負載身分。請參閱使用 Admin API 管理 WIF。
管理將發行者權杖對應到服務帳戶和範圍的規則(fdrl_...)。請參閱使用 Admin API 管理 WIF。
使用 /v1/organizations/me 端點以程式化方式取得您組織的資訊。
例如:
curl "https://api.anthropic.com/v1/organizations/me" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"{
"id": "12345678-1234-5678-1234-567812345678",
"type": "organization",
"name": "Organization Name"
}此端點對於以程式化方式判斷 Admin API 金鑰屬於哪個組織很有用。
有關完整的參數詳細資訊和回應結構描述,請參閱組織資訊 API 參考。
使用使用量和成本 API 追蹤您組織的使用量和成本。
使用 Claude Code 分析 API 監控開發人員生產力和 Claude Code 的採用情況。
使用速率限制 API 讀取為您的組織及其工作區設定的速率限制。
使用 Compliance API 擷取您組織的稽核和活動資料。Admin API 金鑰只能讀取活動摘要(Activity Feed);如需完整存取權限,請參閱設定 Compliance API。
為了有效使用 Admin API:
expires_at,並定期輪換金鑰有關工作區的特定問題,請參閱工作區常見問題。
Was this page helpful?