フェデレーションルールを作成
POST/v1/organizations/federation_rules
org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。
組織が所有するフェデレーションルールを作成します。
参照される発行者とターゲットのサービスアカウントは、同じ組織内にすでに存在している必要があります。無効な参照は 400 エラーで拒否されます。ワークスペース参照は検証されます。メンバーシップはルール作成時にはチェックされません。トークン交換は呼び出しごとに単一の有効化されたワークスペースを解決し、ターゲットのサービスアカウントがそのワークスペースのメンバーでない限り拒否されます（デフォルトワークスペースには暗黙的にメンバーとして所属します）。よく知られた共有発行者（GitHub Actions、GitLab、Buildkite、Terraform Cloud、Google）上のルールは、ID を含むクレーム、テナントを固定するサブジェクトプレフィックス（repo:YOUR_ORG/... など）、またはそれらの ID クレームのいずれかを参照する CEL 条件（例: claims.repository_owner）によってテナント ID を制約する必要があります。OAuth 呼び出し元が管理できるのは、oauth_scope が workspace:developer または workspace:inference のルールのみです。その他のスコープには Console セッションが必要です。
Parameters
Returns
フェデレーションルールを作成
RuleCreateParams parameters = new()
{
IssuerID = "issuer_id",
Match = new()
{
Audience = "audience",
Claims = new Dictionary<string, string>() { { "foo", "string" } },
Condition = "condition",
SubjectPrefix = "subject_prefix",
},
Name = "x",
OAuthScope = "x",
Target = new()
{
ServiceAccountID = "svac_01SDCCSbTxrXDpWc1phhtcfK",
ServiceAccountName = "service_account_name",
},
};
var betaFederationRule = await client.Beta.Organization.Federation.Rules.Create(parameters);
Console.WriteLine(betaFederationRule);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"
]
}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"
]
}