フェデレーションルールを更新
org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。
フェデレーションルールを部分的に更新します。
issuer_id は不変です。match と target は、設定されるとオブジェクト全体として置き換えられます。参照されるサービスアカウントとワークスペースは組織内に存在している必要があります。無効な参照は 400 エラーで拒否されます。アーカイブ済みのルールは更新できず、400 が返されます。代わりに新しいルールを作成してください。よく知られた共有発行者（GitHub Actions、GitLab、Buildkite、Terraform Cloud、Google）上のルールは、ID を含むクレーム、テナントを固定するサブジェクトプレフィックス（repo:YOUR_ORG/... など）、またはそれらの ID クレームのいずれかを参照する CEL 条件（例: claims.repository_owner）によってテナント ID を制約する必要があります。これらの発行者では、この要件は更新のたびに再チェックされます。既存のルールに保存されている match がまだテナント ID を制約していない場合、どのような更新（名前の変更や説明の変更であっても）でも、同じリクエスト内で要件に適合する match を併せて指定する必要があります。OAuth 呼び出し元が管理できるのは、oauth_scope が workspace:developer または workspace:inference のルールのみです。その他のスコープには Console セッションが必要です。
Parameters
Returns
RuleUpdateParams parameters = new() { FederationRuleID = "federation_rule_id" };
var betaFederationRule = await client.Beta.Organization.Federation.Rules.Update(parameters);
Console.WriteLine(betaFederationRule);{
"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"
]
}