Claude Platform Docs

封存聯合規則

client.Organization.Federation.Rules.Archive(ctx, federationRuleID) (*FederationRule, error)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

封存聯合規則。

透過此規則的權杖交換會立即停止。此操作具冪等性；重複封存會傳回帶有原始 archived_at 的規則。封存會清除規則的工作區目標設定（workspace_id 和 workspace_ids 會被清空）。封存前已核發的權杖在到期前仍然有效。OAuth 呼叫者只能管理 oauth_scope 為 workspace:developer 或 workspace:inference 的規則；其他範圍需要 Console 工作階段。

Parameters
federationRuleID string⁠Path parameter

ID of the federation rule to archive.

Returns
type FederationRule struct { Type: "federation_rule"; ID; AppliesToAllWorkspaces; /* 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.

封存聯合規則
package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"),
	)
	federationRule, err := client.Organization.Federation.Rules.Archive(context.TODO(), "federation_rule_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", federationRule.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"
  ]
}