Créer une règle de fédération
Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.
Créez une règle de fédération appartenant à votre organisation.
L'émetteur référencé et le compte de service cible doivent déjà exister
dans la même organisation ; les références non valides sont rejetées avec une erreur
400. La référence à l'espace de travail est validée. L'appartenance n'est pas vérifiée
lors de la création de la règle : l'échange de jetons résout un seul espace de travail activé par
appel et est rejeté sauf si le compte de service cible est membre de
cet espace de travail (il est implicitement membre de l'espace de travail par défaut).
Les règles portant sur des émetteurs partagés bien connus (GitHub Actions, GitLab, Buildkite,
Terraform Cloud, Google) doivent contraindre l'identité du locataire via une
revendication porteuse d'identité, un préfixe de sujet épinglant le locataire (tel que
repo:YOUR_ORG/...) ou une condition CEL référençant l'une de ces
revendications d'identité (par exemple claims.repository_owner). Les appelants OAuth ne peuvent
gérer que les règles dont oauth_scope vaut workspace:developer ou
workspace:inference ; les autres portées nécessitent une session 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);{
"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"
]
}