Claude Platform Docs

Federation-Regel aktualisieren

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

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, über ant auth login --scope org:admin oder eine Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Aktualisiert eine Federation-Regel teilweise.

issuer_id ist unveränderlich. match und target werden beim Setzen als ganze Objekte ersetzt. Referenzierte Service-Accounts und Workspaces müssen in deiner Organisation existieren; ungültige Referenzen werden mit einem 400-Fehler abgelehnt. Archivierte Regeln können nicht aktualisiert werden; dies gibt 400 zurück. Erstelle stattdessen eine neue Regel. Regeln für bekannte gemeinsam genutzte Issuer (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) müssen die Tenant-Identität über einen identitätstragenden Claim, ein Tenant-fixierendes Subject-Präfix (wie repo:YOUR_ORG/...) oder eine CEL-Bedingung einschränken, die auf einen dieser Identitäts-Claims verweist (z. B. claims.repository_owner). Bei diesen Issuern wird die Anforderung bei jeder Aktualisierung erneut geprüft; wenn das gespeicherte Match einer bestehenden Regel die Tenant-Identität noch nicht einschränkt, muss jede Aktualisierung (selbst eine Umbenennung oder Änderung der Beschreibung) in derselben Anfrage auch ein konformes match mitliefern. OAuth-Aufrufer dürfen nur Regeln verwalten, deren oauth_scope workspace:developer oder workspace:inference ist; andere Scopes erfordern eine Console-Sitzung.

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.

description: String

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

maxLength2000
match: FederationRuleMatch { 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: ServiceAccountTarget { 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.

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.

Federation-Regel aktualisieren
require "anthropic"

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

federation_rule = anthropic.organization.federation.rules.update("federation_rule_id")

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"
  ]
}