Skip to content

Add support for OIDC custom fields #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wlthomson merged 3 commits into from
Nov 27, 2025
Merged

Add support for OIDC custom fields #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73dbdee
Add support for OIDC custom fields
wlthomson Nov 27, 2025
a49d630
Add custom claims to az oidc example
wlthomson Nov 27, 2025
5f12ff6
Simplify comment
wlthomson Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions examples/accounts/create_azure_oidc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ func CreateAzureOIDCExample() {
// Other claims
audience string = ""

// Optional custom claims
customClaims = map[string]string{
"claim1": "value1",
"claim2": "value2",
}

// account values
accountName string = "Azure Account"
accountDescription string = "My Azure Account"
Expand Down Expand Up @@ -59,6 +65,7 @@ func CreateAzureOIDCExample() {
azureAccount.HealthCheckSubjectKeys = healthCheckSubjectKeys
azureAccount.AccountTestSubjectKeys = accountTestSubjectKeys
azureAccount.Audience = audience
azureAccount.CustomClaims = customClaims

// fill in account details
azureAccount.Description = accountDescription
Expand Down
1 change: 1 addition & 0 deletions pkg/accounts/account_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ type AccountResource struct {
AccountTestSubjectKeys []string `json:"AccountTestSubjectKeys,omitempty"`
RoleArn string `json:"RoleArn,omitempty"`
SessionDuration string `json:"SessionDuration,omitempty"`
CustomClaims map[string]string `json:"CustomClaims,omitempty"`

resources.Resource
}
Expand Down
6 changes: 6 additions & 0 deletions pkg/accounts/account_utilities.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ func ToAccount(accountResource *AccountResource) (IAccount, error) {
awsOIDCAccount.DeploymentSubjectKeys = accountResource.DeploymentSubjectKeys
awsOIDCAccount.AccountTestSubjectKeys = accountResource.AccountTestSubjectKeys
awsOIDCAccount.HealthCheckSubjectKeys = accountResource.HealthCheckSubjectKeys
awsOIDCAccount.CustomClaims = accountResource.CustomClaims
account = awsOIDCAccount
case AccountTypeAzureServicePrincipal:
azureServicePrincipalAccount, err := NewAzureServicePrincipalAccount(accountResource.GetName(), *accountResource.SubscriptionID, *accountResource.TenantID, *accountResource.ApplicationID, accountResource.ApplicationPassword)
Expand All @@ -57,6 +58,7 @@ func ToAccount(accountResource *AccountResource) (IAccount, error) {
azureOIDCAccount.DeploymentSubjectKeys = accountResource.DeploymentSubjectKeys
azureOIDCAccount.AccountTestSubjectKeys = accountResource.AccountTestSubjectKeys
azureOIDCAccount.HealthCheckSubjectKeys = accountResource.HealthCheckSubjectKeys
azureOIDCAccount.CustomClaims = accountResource.CustomClaims
account = azureOIDCAccount
case AccountTypeAzureSubscription:
azureSubscriptionAccount, err := NewAzureSubscriptionAccount(accountResource.GetName(), *accountResource.SubscriptionID)
Expand All @@ -76,6 +78,7 @@ func ToAccount(accountResource *AccountResource) (IAccount, error) {
}
genericOIDCAccount.Audience = accountResource.Audience
genericOIDCAccount.DeploymentSubjectKeys = accountResource.DeploymentSubjectKeys
genericOIDCAccount.CustomClaims = accountResource.CustomClaims
account = genericOIDCAccount
case AccountTypeGoogleCloudPlatformAccount:
googleCloudPlatformAccount, err := NewGoogleCloudPlatformAccount(accountResource.GetName(), accountResource.JsonKey)
Expand Down Expand Up @@ -154,6 +157,7 @@ func ToAccountResource(account IAccount) (*AccountResource, error) {
accountResource.DeploymentSubjectKeys = awsOIDCAccount.DeploymentSubjectKeys
accountResource.AccountTestSubjectKeys = awsOIDCAccount.AccountTestSubjectKeys
accountResource.HealthCheckSubjectKeys = awsOIDCAccount.HealthCheckSubjectKeys
accountResource.CustomClaims = awsOIDCAccount.CustomClaims
case AccountTypeAzureServicePrincipal:
azureServicePrincipalAccount := account.(*AzureServicePrincipalAccount)
accountResource.ApplicationID = azureServicePrincipalAccount.ApplicationID
Expand All @@ -175,6 +179,7 @@ func ToAccountResource(account IAccount) (*AccountResource, error) {
accountResource.DeploymentSubjectKeys = azureOIDCAccount.DeploymentSubjectKeys
accountResource.AccountTestSubjectKeys = azureOIDCAccount.AccountTestSubjectKeys
accountResource.HealthCheckSubjectKeys = azureOIDCAccount.HealthCheckSubjectKeys
accountResource.CustomClaims = azureOIDCAccount.CustomClaims
case AccountTypeAzureSubscription:
azureSubscriptionAccount := account.(*AzureSubscriptionAccount)
accountResource.AzureEnvironment = azureSubscriptionAccount.AzureEnvironment
Expand All @@ -187,6 +192,7 @@ func ToAccountResource(account IAccount) (*AccountResource, error) {
genericOidcAccount := account.(*GenericOIDCAccount)
accountResource.DeploymentSubjectKeys = genericOidcAccount.DeploymentSubjectKeys
accountResource.Audience = genericOidcAccount.Audience
accountResource.CustomClaims = genericOidcAccount.CustomClaims
case AccountTypeGoogleCloudPlatformAccount:
googleCloudPlatformAccount := account.(*GoogleCloudPlatformAccount)
accountResource.JsonKey = googleCloudPlatformAccount.JsonKey
Expand Down
13 changes: 7 additions & 6 deletions pkg/accounts/aws_oidc_account.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ import (

// AwsOIDCAccount represents an AWS OIDC account.
type AwsOIDCAccount struct {
RoleArn string `json:"RoleArn"`
SessionDuration string `json:"SessionDuration,omitempty"`
Audience string `json:"Audience,omitempty"`
DeploymentSubjectKeys []string `json:"DeploymentSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space environment project tenant runbook account type'"`
HealthCheckSubjectKeys []string `json:"HealthCheckSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account target type'"`
AccountTestSubjectKeys []string `json:"AccountTestSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account type'"`
RoleArn string `json:"RoleArn"`
SessionDuration string `json:"SessionDuration,omitempty"`
Audience string `json:"Audience,omitempty"`
DeploymentSubjectKeys []string `json:"DeploymentSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space environment project tenant runbook account type'"`
HealthCheckSubjectKeys []string `json:"HealthCheckSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account target type'"`
AccountTestSubjectKeys []string `json:"AccountTestSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account type'"`
CustomClaims map[string]string `json:"CustomClaims,omitempty"`

account
}
Expand Down
25 changes: 16 additions & 9 deletions pkg/accounts/aws_oidc_account_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ func TestAwsOIDCAccount(t *testing.T) {
invalidDeploymentSubjectKeys := []string{"space", "target"}
invalidHealthCheckSubjectKeys := []string{"space", "project"}
invalidAccountTestSubjectKeys := []string{"space", "project"}
customClaims := map[string]string{
"claim1": "value1",
"claim2": "value2",
}

testCases := []struct {
TestName string
Expand All @@ -32,16 +36,18 @@ func TestAwsOIDCAccount(t *testing.T) {
DeploymentSubjectKeys []string
HealthCheckSubjectKeys []string
AccountTestSubjectKeys []string
CustomClaims map[string]string
}{
{"Valid", false, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys},
{"EmptyName", true, "", spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys},
{"WhitespaceName", true, " ", spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys},
{"EmptySpaceID", false, name, "", tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys},
{"WhitespaceSpaceID", false, name, " ", tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys},
{"NilSubjectKeys", false, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, nil, nil, nil},
{"InvalidDeploymentSubjectKeys", true, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, invalidDeploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys},
{"InvalidHealthCheckSubjectKeys", true, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, invalidHealthCheckSubjectKeys, invalidAccountTestSubjectKeys},
{"InvalidAccountTestSubjectKeys", true, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, invalidAccountTestSubjectKeys},
{"Valid", false, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, nil},
{"ValidWithCustomClaims", false, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, customClaims},
{"EmptyName", true, "", spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, nil},
{"WhitespaceName", true, " ", spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, nil},
{"EmptySpaceID", false, name, "", tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, nil},
{"WhitespaceSpaceID", false, name, " ", tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, nil},
{"NilSubjectKeys", false, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, nil, nil, nil, nil},
{"InvalidDeploymentSubjectKeys", true, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, invalidDeploymentSubjectKeys, healthCheckSubjectKeys, accountTestSubjectKeys, nil},
{"InvalidHealthCheckSubjectKeys", true, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, invalidHealthCheckSubjectKeys, invalidAccountTestSubjectKeys, nil},
{"InvalidAccountTestSubjectKeys", true, name, spaceID, tenantedDeploymentMode, roleArn, sessionDuration, deploymentSubjectKeys, healthCheckSubjectKeys, invalidAccountTestSubjectKeys, nil},
}
for _, tc := range testCases {
t.Run(tc.TestName, func(t *testing.T) {
Expand All @@ -51,6 +57,7 @@ func TestAwsOIDCAccount(t *testing.T) {
DeploymentSubjectKeys: tc.DeploymentSubjectKeys,
HealthCheckSubjectKeys: tc.HealthCheckSubjectKeys,
AccountTestSubjectKeys: tc.AccountTestSubjectKeys,
CustomClaims: tc.CustomClaims,
}
awsOIDCAccount.AccountType = AccountTypeAwsOIDC
awsOIDCAccount.Name = tc.Name
Expand Down
21 changes: 11 additions & 10 deletions pkg/accounts/azure_oidc_account.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ import (

// AzureOIDCAccount represents an Azure OIDC account.
type AzureOIDCAccount struct {
ApplicationID *uuid.UUID `json:"ClientId" validate:"required"`
AuthenticationEndpoint string `json:"ActiveDirectoryEndpointBaseUri,omitempty" validate:"required_with=AzureEnvironment,omitempty,uri"`
AzureEnvironment string `json:"AzureEnvironment,omitempty" validate:"omitempty,oneof=AzureCloud AzureChinaCloud AzureGermanCloud AzureUSGovernment"`
ResourceManagerEndpoint string `json:"ResourceManagementEndpointBaseUri" validate:"required_with=AzureEnvironment,omitempty,uri"`
SubscriptionID *uuid.UUID `json:"SubscriptionNumber" validate:"required"`
TenantID *uuid.UUID `json:"TenantId" validate:"required"`
Audience string `json:"Audience,omitempty"`
DeploymentSubjectKeys []string `json:"DeploymentSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space environment project tenant runbook account type'"`
HealthCheckSubjectKeys []string `json:"HealthCheckSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account target type'"`
AccountTestSubjectKeys []string `json:"AccountTestSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account type'"`
ApplicationID *uuid.UUID `json:"ClientId" validate:"required"`
AuthenticationEndpoint string `json:"ActiveDirectoryEndpointBaseUri,omitempty" validate:"required_with=AzureEnvironment,omitempty,uri"`
AzureEnvironment string `json:"AzureEnvironment,omitempty" validate:"omitempty,oneof=AzureCloud AzureChinaCloud AzureGermanCloud AzureUSGovernment"`
ResourceManagerEndpoint string `json:"ResourceManagementEndpointBaseUri" validate:"required_with=AzureEnvironment,omitempty,uri"`
SubscriptionID *uuid.UUID `json:"SubscriptionNumber" validate:"required"`
TenantID *uuid.UUID `json:"TenantId" validate:"required"`
Audience string `json:"Audience,omitempty"`
DeploymentSubjectKeys []string `json:"DeploymentSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space environment project tenant runbook account type'"`
HealthCheckSubjectKeys []string `json:"HealthCheckSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account target type'"`
AccountTestSubjectKeys []string `json:"AccountTestSubjectKeys,omitempty" validate:"omitempty,dive,oneof=space account type'"`
CustomClaims map[string]string `json:"CustomClaims,omitempty"`

account
}
Expand Down
Loading
Loading