Claude Platform Docs

Crea regola di federazione

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

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Crea una regola di federazione di proprietà della tua organizzazione.

L'emittente a cui si fa riferimento e l'account di servizio di destinazione devono già esistere nella stessa organizzazione; i riferimenti non validi vengono rifiutati con un errore 400. Il riferimento al workspace viene convalidato. L'appartenenza non viene verificata alla creazione della regola: lo scambio di token risolve un singolo workspace abilitato per chiamata e viene rifiutato a meno che l'account di servizio di destinazione non sia membro di quel workspace (è implicitamente membro del workspace predefinito). Le regole su emittenti condivisi noti (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) devono vincolare l'identità del tenant tramite un claim che identifica l'identità, un prefisso del subject che fissa il tenant (come repo:YOUR_ORG/...) o una condizione CEL che fa riferimento a uno di tali claim di identità (ad es. claims.repository_owner). I chiamanti OAuth possono gestire solo regole il cui oauth_scope è workspace:developer o workspace:inference; gli altri scope richiedono una sessione della Console.

Parameters
issuer_id: str

Tagged ID of the federation issuer.

match: FederationRuleMatchParam

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: Optional[str]

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: Optional[Dict[str, str]]

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

condition: Optional[str]

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: Optional[str]

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: str

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

minLength1
maxLength255
oauth_scope: str

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: ServiceAccountTargetParam

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

type: Literal["service_account"]
service_account_id: str

Tagged ID of the service account to mint tokens for.

service_account_name: Optional[str]

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

applies_to_all_workspaces: Optional[bool]

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

description: Optional[str]

Optional free-text description.

maxLength2000
token_lifetime_seconds: Optional[int]

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: Optional[str]

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.

Crea regola di federazione
import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
federation_rule = client.organization.federation.rules.create(
    issuer_id="issuer_id",
    match={},
    name="x",
    oauth_scope="x",
    target={
        "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
        "type": "service_account",
    },
)
print(federation_rule.id)
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"
  ]
}