Claude Platform Docs

Atualizar regra de federação

beta.organization.federation.rules.update(federation_rule_id, **kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.

Atualize parcialmente uma regra de federação.

issuer_id é imutável. match e target são substituídos como objetos inteiros quando definidos. As contas de serviço e os workspaces referenciados devem existir em sua organização; referências inválidas são rejeitadas com um erro 400. Regras arquivadas não podem ser atualizadas; isso retorna 400. Crie uma nova regra em vez disso. Regras em emissores compartilhados conhecidos (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) devem restringir a identidade do tenant por meio de uma claim portadora de identidade, um prefixo de subject que fixe o tenant (como repo:YOUR_ORG/...) ou uma condição CEL que referencie uma dessas claims de identidade (por exemplo, claims.repository_owner). Nesses emissores, o requisito é verificado novamente a cada atualização; se o match armazenado de uma regra existente ainda não restringir a identidade do tenant, qualquer atualização (mesmo uma renomeação ou alteração de descrição) também deve fornecer um match em conformidade na mesma solicitação. Chamadores OAuth só podem gerenciar regras cujo oauth_scope seja workspace:developer ou workspace:inference; outros escopos exigem uma sessão do Console.

Parameters
federation_rule_id: String⁠Path parameter

ID of the federation rule to update.

applies_to_all_workspaces: bool

When true, enables this rule for every workspace in the org (including workspaces created later). Setting false is rejected with 400 if no workspace would remain enabled; a rule with only a legacy workspace_id binding continues to mint.

attributes: Hash[Symbol, String]

Replaces the CEL expressions {name: expr} extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400.

description: String

Replaces the description. Omit to leave unchanged; send null to clear (the field is stored as an empty string).

maxLength2000
match: BetaFederationRuleMatch { audience, claims, condition, subject_prefix }

Replaces the entire match object. All populated matcher fields must pass.

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

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

minLength1
maxLength255
oauth_scope: String

Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set workspace:developer or workspace:inference; other scopes (such as org:admin) require a Console session.

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

Replaces the entire target object. 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.

token_lifetime_seconds: Integer

Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at max(60, min(this value, 2 × remaining assertion validity)) seconds.

minimum60
maximum86400
workspace_id: String

Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the /federation_rules/{federation_rule_id}/workspaces sub-resource instead.

betas: Array[AnthropicBeta]⁠Header parameter

Optional header to specify the beta version(s) you want to use.

One of the following:
String = String
:"message-batches-2024-09-24"
:"prompt-caching-2024-07-31"
:"computer-use-2024-10-22"
:"computer-use-2025-01-24"
:"pdfs-2024-09-25"
:"token-counting-2024-11-01"
:"token-efficient-tools-2025-02-19"
:"output-128k-2025-02-19"
:"files-api-2025-04-14"
:"mcp-client-2025-04-04"
:"mcp-client-2025-11-20"
:"dev-full-thinking-2025-05-14"
:"interleaved-thinking-2025-05-14"
:"code-execution-2025-05-22"
:"extended-cache-ttl-2025-04-11"
:"context-1m-2025-08-07"
:"context-management-2025-06-27"
:"model-context-window-exceeded-2025-08-26"
:"skills-2025-10-02"
:"fast-mode-2026-02-01"
:"output-300k-2026-03-24"
:"user-profiles-2026-03-24"
:"user-profiles-2026-08-18"
:"user-profiles-2026-09-04"
:"advisor-tool-2026-03-01"
:"managed-agents-2026-04-01"
:"cache-diagnosis-2026-04-07"
:"dreaming-2026-04-21"
:"thinking-token-count-2026-05-13"
:"server-side-fallback-2026-06-01"
:"server-side-fallback-2026-07-01"
:"fallback-credit-2026-06-01"
:"fallback-credit-2026-07-01"
:"agent-memory-2026-07-22"
:"mid-conversation-tool-changes-2026-07-01"
:"compact-2026-01-12"
:"computer-use-2025-11-24"
:"mcp-tunnels-2026-06-22"
:"structured-outputs-2025-11-13"
:"task-budgets-2026-03-13"
:"thinking-display-updates-2026-08-18"
:"ce-user-management-2026-07-13"
:"mid-conversation-output-config-2026-07-01"
:"thinking-binding-controls-2026-08-01"
:"mid-conversation-system-clear-at-2026-08-21"
:"compact-2026-09-04"
:"inline-tools-2026-09-15"
:"mcp-client-2026-09-15"
:"ce-plugins-2026-09-01"
:"spend-limit-reads-2026-09-26"
:"telemetry-destinations-2026-08-11"
Returns
class BetaFederationRule { type: :federation_rule, id, applies_to_all_workspaces, 17 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.

Atualizar regra de federação
require "anthropic"

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

beta_federation_rule = anthropic.beta.organization.federation.rules.update("federation_rule_id")

puts(beta_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"
  ]
}