Federation-Regel erstellen
Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.
Erstellt eine Federation-Regel im Besitz deiner Organisation.
Der referenzierte Issuer und der Ziel-Service-Account müssen bereits in derselben
Organisation existieren; ungültige Verweise werden mit einem 400-Fehler
abgelehnt. Der Workspace-Verweis wird validiert. Die Mitgliedschaft wird bei der
Regelerstellung nicht geprüft: Der Token-Austausch löst pro Aufruf einen einzelnen aktivierten Workspace
auf und wird abgelehnt, sofern der Ziel-Service-Account kein Mitglied dieses
Workspace ist (er ist implizit Mitglied des Standard-Workspace).
Regeln für bekannte gemeinsam genutzte Issuer (GitHub Actions, GitLab, Buildkite,
Terraform Cloud, Google) müssen die Mandantenidentität über einen
identitätstragenden Claim, ein mandantenbindendes Subject-Präfix (wie
repo:YOUR_ORG/...) oder eine CEL-Bedingung einschränken, die auf einen dieser
Identitäts-Claims verweist (z. B. claims.repository_owner). OAuth-Aufrufer dürfen nur
Regeln verwalten, deren oauth_scope workspace:developer oder
workspace:inference ist; andere Scopes erfordern eine Console-Sitzung.
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);{
"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"
]
}