Claude Platform Docs

建立聯合規則

organization.federation.rules.create(**kwargs) -> FederationRule
POST/v1/organizations/federation_rules

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

建立由您組織擁有的聯合規則。

所參照的簽發者與目標服務帳戶必須已存在於同一組織中；無效的參照會以 400 錯誤拒絕。工作區參照會經過驗證。建立規則時不會檢查成員資格：權杖交換每次呼叫會解析單一已啟用的工作區，除非目標服務帳戶是該工作區的成員，否則會被拒絕（服務帳戶隱含為預設工作區的成員）。位於知名共用簽發者（GitHub Actions、GitLab、Buildkite、Terraform Cloud、Google）上的規則，必須透過帶有身分的宣告、固定租用戶的主體前綴（例如 repo:YOUR_ORG/...），或參照上述身分宣告之一的 CEL 條件（例如 claims.repository_owner）來限制租用戶身分。OAuth 呼叫者只能管理 oauth_scope 為 workspace:developer 或 workspace:inference 的規則；其他範圍需要 Console 工作階段。

Parameters
issuer_id: String

Tagged ID of the federation issuer.

match: FederationRuleMatch { audience, claims, condition, subject_prefix }

Conditions the verified JWT must satisfy for this rule to apply. At least one of subject_prefix (other than a wildcard-only value like *), claims, or condition is required; audience alone is not sufficient.

audience: String

Exact match against the aud claim (any element if array). When omitted, the JWT's aud must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.

maxLength1024
claims: Hash[Symbol, String]

Exact-match {claim: value} pairs against top-level claims. Only string-valued claims can be matched; use condition for non-string claims.

condition: String

CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the claims variable; a constant-true expression (such as true) is rejected with 400.

maxLength4096
subject_prefix: String

Match the verified JWT sub claim. Exact match unless the value ends with *, in which case it is a prefix match. Example: repo:my-org/my-repo:ref:refs/heads/main.

maxLength1024
name: String

Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.

minLength1
maxLength255
oauth_scope: String

Space-separated OAuth scopes. OAuth callers may only set workspace:developer or workspace:inference; other scopes (such as org:admin) require a Console session.

minLength1
target: ServiceAccountTarget { type: :service_account, service_account_id, service_account_name }

Identity that tokens minted via this rule act as. Currently always a service_account target.

type: :service_account
service_account_id: String

Tagged ID of the service account to mint tokens for.

service_account_name: String

Service account's display name at read time. Ignored on writes.

applies_to_all_workspaces: bool

When true, enable this rule for every workspace in the org (including workspaces created later).

description: String

Optional free-text description.

maxLength2000
token_lifetime_seconds: Integer

Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at max(60, min(this value, 2 × remaining assertion validity)) seconds.

minimum60
maximum86400
workspace_id: String

Tagged ID of the workspace to enable this rule for. Required unless applies_to_all_workspaces is true. Additional workspaces can be added via the /federation_rules/{federation_rule_id}/workspaces sub-resource.

Returns
class FederationRule { type: :federation_rule, id, applies_to_all_workspaces, 15 more }

Authorization rule binding an external OIDC identity to Anthropic.

Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via workspace_ids or applies_to_all_workspaces, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy workspace_id binding do not enforce this.

建立聯合規則
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

federation_rule = anthropic.organization.federation.rules.create(
  issuer_id: "issuer_id",
  match: {},
  name: "x",
  oauth_scope: "x",
  target: {service_account_id: "svac_01SDCCSbTxrXDpWc1phhtcfK", type: :service_account}
)

puts(federation_rule)
Returns Examples
Response 200
{
  "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
  "applies_to_all_workspaces": true,
  "archived_at": "2019-12-27T18:11:19.117Z",
  "archived_by_actor_id": "archived_by_actor_id",
  "attributes": {
    "foo": "string"
  },
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by_actor_id": "created_by_actor_id",
  "description": "description",
  "issuer_id": "issuer_id",
  "issuer_name": "issuer_name",
  "match": {
    "audience": "audience",
    "claims": {
      "foo": "string"
    },
    "condition": "condition",
    "subject_prefix": "subject_prefix"
  },
  "name": "prod-deploy-pipeline",
  "oauth_scope": "oauth_scope",
  "target": {
    "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
    "type": "service_account",
    "service_account_name": "service_account_name"
  },
  "token_lifetime_seconds": 0,
  "type": "federation_rule",
  "updated_at": "2024-10-30T23:58:27.427722Z",
  "updated_by_actor_id": "updated_by_actor_id",
  "workspace_id": "workspace_id",
  "workspace_ids": [
    "string"
  ]
}