WIF 參考
Workload Identity Federation 的環境變數、驗證規則、設定檔組態與錯誤參考。
本頁彙整了 Workload Identity Federation(工作負載身分聯合)的組態介面、驗證限制與錯誤對應。如需設定逐步教學,請參閱提供者指南。
權杖交換請求
POST /v1/oauth/token 接受使用 RFC 7523 jwt-bearer 授權類型的 JSON 主體。SDK 會根據環境變數為您建構此請求;各提供者指南中的 cURL 範例展示了原始主體。
| 欄位 | 必填 | 說明 |
|---|---|---|
grant_type | 是 | 一律為 urn:ietf:params:oauth:grant-type:jwt-bearer。 |
assertion | 是 | 由您的身分提供者簽發的 OIDC JWT。 |
federation_rule_id | 是 | 要評估之聯合規則的標記 ID(fdrl_...)。 |
organization_id | 是 | 您的 Anthropic 組織的 UUID。 |
service_account_id | 是 | 目標服務帳戶的標記 ID(svac_...)。 |
workspace_id | 視條件而定 | 要將鑄造的權杖限定範圍至的工作區標記 ID(wrkspc_...),或以字面值 default 表示組織的預設工作區。當規則啟用於多個工作區時為必填。省略時,伺服器會選取該規則唯一啟用的工作區。 |
權杖交換回應
POST /v1/oauth/token 會回傳標準的 OAuth 2.0 權杖回應(RFC 6749 §5.1):
| 欄位 | 類型 | 說明 |
|---|---|---|
access_token | string | 短效期的 Anthropic 權杖,前綴為 sk-ant-oat01-...。請以 Authorization: Bearer <token> 傳遞。 |
token_type | string | 一律為 Bearer。 |
expires_in | integer | 權杖到期前的秒數。 |
scope | string | 由相符規則授予的 OAuth 範圍。 |
環境變數
SDK 會讀取這些變數,以在不需建構函式引數的情況下執行聯合權杖交換。
| 變數 | 必填 | 說明 | 範例 |
|---|---|---|---|
ANTHROPIC_FEDERATION_RULE_ID | 是 | 要評估之聯合規則的標記 ID。 | fdrl_... |
ANTHROPIC_ORGANIZATION_ID | 是 | 您的 Anthropic 組織的 UUID。可在 Claude Console 的 Settings > Organization 下找到。 | 00000000-0000-0000-0000-000000000000 |
ANTHROPIC_IDENTITY_TOKEN_FILE | _TOKEN_FILE 或 _TOKEN 其中之一 | 由您的「identity provider」(身分提供者),即 IdP 所簽發之 JWT 的檔案系統路徑。SDK 會在每次交換時重新讀取此檔案,以確保在磁碟上輪替的投射權杖始終為最新。 | /var/run/secrets/anthropic.com/token |
ANTHROPIC_IDENTITY_TOKEN | _TOKEN_FILE 或 _TOKEN 其中之一 | 以字串形式提供的字面 JWT。當您的平台以環境變數而非檔案注入權杖時使用。 | eyJhbGciOiJSUzI1NiIs... |
ANTHROPIC_SERVICE_ACCOUNT_ID | 是 | 所簽發的存取權杖將以其身分運作的目標 Anthropic 服務帳戶標記 ID。 | svac_... |
ANTHROPIC_WORKSPACE_ID | 視條件而定 | 要將鑄造的權杖限定範圍至的工作區標記 ID,或字面值 default。當聯合規則啟用於多個工作區時為必填;當規則繫結至單一工作區時為選填。鑄造的權杖會在交換時限定於此工作區,因此切換工作區需要進行新的交換。 | wrkspc_... |
ANTHROPIC_PROFILE | 否 | 要載入的組態設定檔名稱。優先於本表中的聯合環境變數。 | staging-profile |
直接環境變數聯合路徑僅在 ANTHROPIC_FEDERATION_RULE_ID、ANTHROPIC_ORGANIZATION_ID、ANTHROPIC_SERVICE_ACCOUNT_ID,以及 ANTHROPIC_IDENTITY_TOKEN_FILE 或 ANTHROPIC_IDENTITY_TOKEN 其中之一全部設定時才會啟用。ANTHROPIC_WORKSPACE_ID 會一併讀取,但不影響啟用條件。
憑證優先順序
SDK 依下列順序解析憑證。第一個產生憑證的來源勝出。
| 順序 | 來源 | 備註 |
|---|---|---|
| 1 | 建構函式引數(api_key=、auth_token=、credentials=) | 一律覆寫其他所有來源。 |
| 2 | ANTHROPIC_API_KEY 或 ANTHROPIC_AUTH_TOKEN | 完全遮蔽聯合。從 API 金鑰遷移時請取消設定這些變數。 |
| 3 | ANTHROPIC_PROFILE | 載入 <config_dir>/configs/<name>.json。指定名稱的設定檔若不存在會視為錯誤,而非退回至下一順位。 |
| 4 | 聯合環境變數 | ANTHROPIC_FEDERATION_RULE_ID + ANTHROPIC_ORGANIZATION_ID + ANTHROPIC_SERVICE_ACCOUNT_ID + ANTHROPIC_IDENTITY_TOKEN[_FILE]。 |
| 5 | 作用中設定檔 | 從 <config_dir>/active_config 解析,退回至名為 default 的設定檔。 |
載入設定檔時,環境變數會填補設定檔省略的任何欄位,但絕不會覆寫設定檔明確設定的欄位。例如,ANTHROPIC_WORKSPACE_ID 僅在作用中設定檔未設定 workspace_id 時才會填入該欄位。
設定檔組態檔案
設定檔(profile)是 SDK 與 ant CLI 皆會讀取的具名組態檔案。設定檔讓您能將聯合參數隨容器映像一同發布,或在不變更程式碼的情況下切換環境。
組態目錄
SDK 依下列順序尋找組態目錄:
$ANTHROPIC_CONFIG_DIR- Linux 與 macOS 上的
~/.config/anthropic - Windows 上的
%APPDATA%\Anthropic
作用中設定檔
作用中設定檔名稱依下列順序解析:
$ANTHROPIC_PROFILE<config_dir>/active_config的內容(由ant profile activate <name>寫入的單行檔案)- 字面名稱
default
Claude Code 與 Claude Agent SDK 遵循相同的解析順序,因此在此設定的聯合設定檔也能在無需額外設定的情況下為這些工具進行驗證。
檔案配置
| 路徑 | 內容 | 敏感性 |
|---|---|---|
<config_dir>/configs/<profile>.json | version、authentication 區塊、organization_id、workspace_id 與 base_url。 | 非機密。可安全提交或內建於映像中。 |
<config_dir>/credentials/<profile>.json | version、快取的 access_token、expires_at,以及(互動式登入時的)refresh_token。 | 機密。由 SDK 以模式 0600 寫入。 |
組態檔案與憑證檔案皆帶有頂層字串 version 欄位,格式為 major.minor(目前為 "1.0")。SDK 會自動寫入此欄位,以便未來版本能偵測並遷移較舊的格式;手動撰寫組態時可省略此欄位,SDK 會將該檔案視為目前版本。
聯合設定檔範例
{
"version": "1.0",
"authentication": {
"type": "oidc_federation",
"federation_rule_id": "fdrl_...",
"service_account_id": "svac_...",
"identity_token": {
"source": "file",
"path": "/var/run/secrets/anthropic.com/token"
}
},
"organization_id": "00000000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_...",
"base_url": "https://api.anthropic.com"
}若省略 authentication.identity_token,SDK 會退回至環境中的 ANTHROPIC_IDENTITY_TOKEN_FILE 或 ANTHROPIC_IDENTITY_TOKEN。
OAuth 範圍
您在聯合規則上設定的 oauth_scope 決定了鑄造的存取權杖可呼叫哪些 Claude API 端點。
| 範圍 | 授予存取 |
|---|---|
workspace:developer | 規則所屬工作區中所有非管理性的 Claude API 端點:Messages(包含串流與權杖計數)、Models、Managed Agents 及其工作階段、Files 與 Skills。這與同一工作區中的工作區 API 金鑰所擁有的存取權相符。 |
workspace:inference | 規則所屬工作區中的推論端點:Messages(包含串流與權杖計數)、Models,以及 OpenAI 相容聊天端點。適用於僅需呼叫 Claude、從不需要管理 Files、Skills 或其他資源的工作負載。 |
workspace:manage_tunnels | MCP tunnels API:建立、列出與取得通道、註冊與封存 CA 憑證、顯示與輪替通道權杖,以及封存通道。當您從 Console 的建立通道對話視窗建立規則時,該視窗會鎖定此範圍。 |
org:admin | 完整存取 Admin API(組織成員、邀請、工作區、API 金鑰及其餘項目)。OAuth org:admin 權杖只能建立或修改範圍為 workspace:developer 或 workspace:inference 的規則,且無法更新支援任何其他範圍規則的簽發者;請參閱限制。 |
對權杖範圍以外的端點發出請求會回傳 HTTP 403。目前尚未提供更細緻的範圍(依資源,或讀取與寫入之分)。
權限邊界
聯合規則的 oauth_scope 是上限:鑄造的權杖絕不會超過它。目標服務帳戶的 organization_role(developer 或 admin)決定了可授予哪些範圍,因此授予 org:admin 的規則必須以 organization_role=admin 的服務帳戶為目標。有效權限為規則範圍與服務帳戶角色的交集。
規則 oauth_scope | 服務帳戶 organization_role | 有效權限 |
|---|---|---|
workspace:developer | admin | 僅限規則所屬工作區中的 Claude API 存取。範圍將權杖限制在角色之下。 |
org:admin | admin | 完整的 Admin API 存取(組織成員、邀請、工作區、API 金鑰及其餘項目),但不含 OAuth 呼叫者的例外排除項目;請參閱限制。 |
驗證規則
Anthropic 會在您建立或更新簽發者與規則時,以及在交換時驗證傳入的 JWT 時,強制執行這些限制。
如需完整的參數細節與回應結構描述,請參閱 Service accounts API 參考、Federation issuers API 參考與 Federation rules API 參考。
資源欄位
| 欄位 | 限制 |
|---|---|
簽發者、規則與服務帳戶的 name | 必須符合 ^[a-z0-9-]+$,長度為 1 至 255 個字元。 |
workspace_id | 建立時為必填,除非 applies_to_all_workspaces 為 true。其配額、計費與速率限制適用於依此規則鑄造之權杖的工作區(wrkspc_...)。必須是同一組織中的工作區,且目標服務帳戶必須是該工作區的成員。 |
applies_to_all_workspaces | 布林值。設為 true 可在組織中的每個工作區啟用此規則,而非指定單一工作區;建立時必須提供此欄位或 workspace_id 其中之一。 |
token_lifetime_seconds | 介於 60 與 86400 之間的整數(1 分鐘至 24 小時)。預設為 3600。超出此範圍的值會在請求時被拒絕。請參閱權杖效期與重新整理。 |
URL 欄位
issuer_url、jwks.discovery_base 與 jwks.url 欄位會經過驗證:
| 限制 | 細節 |
|---|---|
| 配置(Scheme) | 必須為 https。 |
| 連接埠 | 必須為 443(明確指定或預設)。 |
| 主機 | 必須是您 OIDC 提供者的公開 DNS 主機名稱。必須解析為公開 IP 位址;不接受 IP 字面值。 |
URL 驗證失敗會回傳 400 invalid_request_error,並以欄位名稱作為錯誤訊息的前綴(例如 issuer_url: url must use https scheme)。
JWT 驗證
| 限制 | 細節 |
|---|---|
| 大小上限 | assertion JWT 最多為 16 KiB。 |
| 簽章演算法 | 僅接受非對稱演算法(RSA 與 ECDSA 系列:ES256、ES384、ES512、RS256、RS384、RS512、PS256、PS384、PS512)。HMAC(HS256、HS384、HS512)與 none 會被拒絕。 |
| 金鑰 ID | JWT 標頭必須帶有與簽發者 JWKS 中某個金鑰相符的 kid。沒有 kid 的權杖會被拒絕。 |
| 必要宣告 | sub 必須存在。iat 必須存在且不得為未來時間。exp 必須存在且為未來時間。 |
| 單次使用 | 帶有 jti 宣告的斷言在每個簽發者下只能交換一次:以相同 jti 重複交換會被視為重送攻擊而拒絕。簽發者的 check_jti 欄位(預設啟用)控制此檢查;沒有 jti 宣告的斷言不受此限制。請參閱 Federation issuers API 參考。 |
| 效期上限 | 權杖的效期(exp 減去 iat)不得超過簽發者設定的上限(預設為 1 小時,可在 Claude Console 中為每個簽發者個別設定)。 |
| 時鐘偏差 | 對 exp、nbf 與 iat 套用 30 秒的寬限。 |
規則比對語意
聯合規則的 match 區塊決定是否接受傳入的 JWT。所有已填入的欄位皆以 AND 語意評估:JWT 必須滿足每一個已填入的比對器。subject_prefix、claims 或 condition 至少須設定其中之一;僅包含 audience(或完全沒有比對器)的 match 區塊會被拒絕。這可防止規則接受來自某簽發者的所有權杖。
| 比對器 | 類型 | 語意 |
|---|---|---|
subject_prefix | string | 與 JWT sub 宣告完全比對。結尾的 * 會使其成為前綴比對(sub 值必須以 * 之前的字元開頭)。區分大小寫。 |
audience | string | JWT aud 宣告必須包含此確切字串。當 aud 為陣列時,任一元素完全相符即滿足檢查。 |
claims | map<string, string> | 每個鍵為頂層宣告名稱,每個值為所需的確切字串值。對於巢狀、數值、布林或清單與對應等複雜宣告,請改用帶有 CEL 運算式的 condition。 |
condition | string (CEL) | 必須評估為 true 的 CEL 運算式。 |
CEL 評估環境
condition 運算式可存取單一變數:
| 變數 | 類型 | 內容 |
|---|---|---|
claims | map | 完整解碼後的 JWT 宣告集。巢狀物件可作為巢狀對應存取。 |
範例:
claims.sub.startsWith("repo:acme-corp/") && claims.ref in ["refs/heads/main", "refs/heads/release"]錯誤
權杖交換錯誤
POST /v1/oauth/token 以標準的 API 錯誤格式回傳錯誤。SDK 會將交換失敗包裝為具型別的 FederationExchangeError(或各語言的對等型別),其中公開 HTTP 狀態、回應主體與 request_id。
| 狀態 | 錯誤 | 原因 | 解決方式 |
|---|---|---|---|
| 400 | invalid_request_error | federation_rule_id 格式錯誤,或缺少必要的請求欄位。 | 確認 fdrl_ ID,並確認請求主體包含所有必要欄位。 |
| 400 | invalid_request_error | workspace_id 存在,但不是格式正確的 wrkspc_... ID 或字面值 default。 | 修正 workspace_id 值;回應訊息會指出預期的格式。 |
| 401 | authentication_error | JWT iss 宣告與已註冊的 issuer_url 不完全相等。 | 逐位元組比對,包含結尾斜線與配置:jq -rR 'split(".")[1] | gsub("-";"+") | gsub("_";"/") | @base64d | fromjson | .iss' <<< "$JWT"。 |
| 401 | authentication_error | JWKS 擷取失敗、JWKS 已過時,或 JWT 以不在 JWKS 中的金鑰簽署。 | 對於 inline 模式,請以輪替後的金鑰更新簽發者。對於 discovery 與 explicit_url,請確認 JWKS 端點可透過連接埠 443 連線;若簽發者最近輪替了簽署金鑰,請參閱金鑰輪替與快取。 |
| 401 | authentication_error | JWT exp 宣告為過去時間(超出 30 秒偏差視窗)。 | 確認您的身分提供者正在投射新的權杖,且 SDK 正在重新讀取權杖檔案。 |
| 401 | authentication_error | JWT 已通過驗證,但其宣告不滿足規則的 match 區塊。 | 解碼 JWT 並將每個宣告與規則比對。subject_prefix 區分大小寫。audience 需要元素完全相符。 |
| 401 | authentication_error | federation_rule_id 不存在、已封存,或 JWT 未獲授權使用該規則(為防止列舉而合併處理)。 | 在 Claude Console 中確認規則 ID,並確認規則尚未封存。 |
| 401 | authentication_error | 聯合規則啟用於多個工作區,而請求省略了 workspace_id。驗證歷程記錄項目會顯示原因 workspace_id_required。 | 將 ANTHROPIC_WORKSPACE_ID(或原始請求中的 workspace_id 主體欄位)設為您希望權杖限定範圍的 wrkspc_... ID。請參閱權杖交換請求。 |
無論是哪一項檢查失敗,每個斷言拒絕皆回傳相同的不透明 401 authentication_error,並帶有固定訊息 Authentication failed;可區分的錯誤會讓呼叫者得以探測規則組態。拒絕原因會記錄在驗證歷程記錄中該次嘗試的項目上,例如當 sub 宣告未通過規則的 subject_prefix 時為 match_subject_prefix,或當規則橫跨多個工作區而請求未指定任何工作區時為 workspace_id_required。在規則所屬組織獲得確認之前即被拒絕的請求(上述 400 invalid_request_error 系列)不會留下歷程記錄項目;其回應訊息會直接指出問題。沒有對應歷程記錄項目的 401 通常表示 federation_rule_id 本身未被識別。
常見的 SDK 端失敗
| 症狀 | 原因 | 解決方式 |
|---|---|---|
| SDK 回報「no credentials」而非進行交換 | ANTHROPIC_FEDERATION_RULE_ID、ANTHROPIC_ORGANIZATION_ID、ANTHROPIC_SERVICE_ACCOUNT_ID 或 ANTHROPIC_IDENTITY_TOKEN[_FILE] 其中之一未設定,且沒有作用中的設定檔。 | 設定全部四個變數,或設定一個設定檔。 |
| SDK 以 API 金鑰驗證而非進行聯合 | 已設定 ANTHROPIC_API_KEY 或 ANTHROPIC_AUTH_TOKEN,且其優先順序勝出。 | 取消設定金鑰或權杖變數。 |
首次請求時出現 FileNotFoundError | ANTHROPIC_IDENTITY_TOKEN_FILE 中的路徑不存在。SDK 會在交換時延遲開啟該檔案。 | 確認投射權杖磁碟區已掛載且路徑相符。 |
| 權杖交換成功,但 Claude API 請求回傳 403 | 鑄造的權杖範圍未授予該端點的存取權。 | 對照 OAuth 範圍檢查規則的 oauth_scope。 |
| 以空憑證驗證失敗 | 某個憑證環境變數已匯出但設為空字串。空值仍會贏得其優先順序位置。 | 以 unset VAR 取消設定變數,而非使用 VAR=""。 |
疑難排解失敗的交換
401 authentication_error 回應刻意設計為不透明,其訊息一律為 Authentication failed;拒絕原因記錄在驗證歷程記錄中,而非回應中。
一種常見的不透明失敗是重送的斷言:帶有 jti 宣告的斷言只能交換一次,因此重新傳送相同 JWT 的工作負載(重試迴圈,或重新讀取未輪替權杖的重新整理)會在第二次交換時被拒絕。驗證歷程記錄頁面會以原因 jti_reused 顯示這些嘗試;修正方式是為每次交換鑄造新的斷言。
若您仍需從 JWT 本身進行除錯,請依序進行下列檢查:
解碼 JWT
解碼您所傳送的斷言,以便將每個宣告與您的簽發者及規則組態比對:
cURLjq -rR 'split(".")[1] | gsub("-";"+") | gsub("_";"/") | @base64d | fromjson' <<< "$JWT"檢查 iss 是否與簽發者相符
解碼後的
iss宣告必須與已註冊的issuer_url逐位元組相等,包含配置、連接埠與任何結尾斜線。單一字元不符即會導致驗證失敗。檢查 aud 是否與規則相符
解碼後的
aud宣告必須包含規則的audience值且完全相符。當aud為陣列時,必須有一個元素完全相符。檢查 sub 與每個 claims 項目
將
sub與規則的subject_prefix比對(區分大小寫;結尾的*為前綴比對,其他情況為完全比對)。將規則claims對應中的每個鍵與同名的頂層宣告比對。檢查 exp、nbf 與 iat
exp必須為未來時間,nbf/iat必須為過去時間,且在 30 秒偏差視窗內。若工作負載主機的時鐘已漂移,原本有效的權杖也會被拒絕。檢查 JWKS 可連線性
對於
discovery模式,請透過連接埠 443 的公開 HTTPS 擷取<jwks.discovery_base or issuer_url>/.well-known/openid-configuration,並確認jwks_uri可解析。對於explicit_url,請直接擷取 JWKS URL。對於inline,請確認簽發者的簽署金鑰自您註冊金鑰以來未曾輪替。若簽發者輪替了簽署金鑰並立即開始以其簽署,在 Anthropic 的 JWKS 快取重新整理期間,交換可能會失敗長達一分鐘。請參閱金鑰輪替與快取。
JWKS 來源模式
當您註冊聯合簽發者時,jwks 欄位控制 Anthropic 如何取得用於驗證該簽發者 JWT 簽章的公開金鑰。它是以 type 為鍵的可辨識聯集(discriminated union):
jwks.type | jwks 結構 | 行為 | 使用時機 |
|---|---|---|---|
discovery(預設) | { "type": "discovery", "discovery_base": "https://..." }(discovery_base 為選填;當探索 URL 與 issuer_url 不同時設定) | Anthropic 擷取 <discovery_base or issuer_url>/.well-known/openid-configuration,從探索文件讀取 jwks_uri,並從該處擷取 JWKS。 | 您的 IdP 在公開網際網路上提供標準的 OIDC 探索文件。大多數受管提供者(EKS、GKE、Cloud Run、GitHub Actions、Entra ID)皆支援此模式。 |
explicit_url | { "type": "explicit_url", "url": "https://..." } | Anthropic 直接從 url 擷取 JWKS。issuer_url 僅用於與 JWT iss 宣告進行字串比對,從不會被連線。 | 您的 IdP 不提供探索文件,或探索僅限內部但 JWKS 可公開連線。 |
inline | { "type": "inline", "keys": [...] } | 您以內嵌方式提供 JWK 物件陣列(JWKS 文件中的 keys 陣列,而非包裝物件)。Anthropic 不會發出任何對外請求。issuer_url 僅用於 iss 比對。 | 實體隔離環境、簽發者 URL 為叢集內部的自行管理 Kubernetes 叢集,或您希望明確控制金鑰輪替時。 |
可辨識聯集在結構上使各伴隨欄位互斥。discovery 與 explicit_url 也都接受選填的 ca_cert_pem 字串,供以私有 CA 提供 TLS 的簽發者使用。
金鑰輪替與快取
在 discovery 與 explicit_url 模式下,Anthropic 會快取擷取到的 JWKS。若您的身分提供者發布新的簽署金鑰並立即開始以其簽署權杖,在快取重新整理期間,出示這些權杖的交換可能會因簽章錯誤而失敗長達 1 分鐘。
為避免此空窗期,請在您的身分提供者開始以新簽署金鑰簽署權杖前至少 15 分鐘,先在 JWKS 中發布該金鑰,並將被取代的金鑰保留在 JWKS 中,直到其所簽署的權杖皆已到期。受管身分提供者通常會自行遵循此規範。若您自行營運簽發者(自行管理的 Kubernetes 叢集、SPIRE OIDC 探索提供者,或設定了輪替週期的 Okta 自訂授權伺服器),請確認您的輪替政策會在首次使用前先發布新金鑰。
Was this page helpful?