フェデレーションルールを更新
org:adminスコープを持つOAuthアクセストークンが必要です。このトークンはant auth login --scope org:adminまたはワークロードアイデンティティフェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin APIでWIFを管理するを参照してください。
フェデレーションルールを部分的に更新します。
issuer_idは変更できません。matchとtargetは、設定された場合にオブジェクト全体として
置き換えられます。参照されるサービスアカウントとワークスペースは組織内に存在している必要があり、
無効な参照は400エラーで拒否されます。アーカイブされたルールは更新できず、400が返されます。
代わりに新しいルールを作成してください。よく知られた共有発行者(GitHub Actions、GitLab、
Buildkite、Terraform Cloud、Google)に対するルールは、アイデンティティを含むクレーム、
テナントを固定するサブジェクトプレフィックス(repo:YOUR_ORG/...など)、またはそれらの
アイデンティティクレームのいずれかを参照するCEL条件(例:claims.repository_owner)によって、
テナントのアイデンティティを制約する必要があります。これらの発行者では、この要件は更新のたびに
再チェックされます。既存のルールに保存されているmatchがまだテナントのアイデンティティを
制約していない場合、いかなる更新(名前や説明の変更であっても)でも、同じリクエスト内で
要件に準拠したmatchを指定する必要があります。OAuth呼び出し元が管理できるのは、oauth_scopeが
workspace:developerまたはworkspace:inferenceであるルールのみです。その他のスコープには
Consoleセッションが必要です。
Parameters
Returns
import os
from anthropic import Anthropic
client = Anthropic(
api_key=os.environ.get(
"ANTHROPIC_API_KEY"
), # This is the default and can be omitted
)
beta_federation_rule = client.beta.organization.federation.rules.update(
federation_rule_id="federation_rule_id",
)
print(beta_federation_rule.id){
"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"
]
}Returns Examples
{
"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"
]
}