feat: add ExternalIDClaim to the APIPortal OIDC status

traefik · Jun 24, 2024 · 241482e · 241482e
1 parent 2565acd
commit 241482e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/pkg/apis/hub/v1alpha1/api_portal.go b/pkg/apis/hub/v1alpha1/api_portal.go
@@ -88,6 +88,10 @@ type OIDCConfigStatus struct {
 	// +optional
 	Scopes string `json:"scopes,omitempty"`
 
+	// ExternalIDClaim is the name of the JWT claim containing the user external ID.
+	// +optional
+	ExternalIDClaim string `json:"externalIdClaim,omitempty"`
+
 	// FirstnameClaim is the name of the JWT claim containing the user firstname.
 	// +optional
 	FirstnameClaim string `json:"firstnameClaim,omitempty"`
@@ -104,7 +108,7 @@ type OIDCConfigStatus struct {
 	// +optional
 	GroupsClaim string `json:"groupsClaim,omitempty"`
 
-	// CompanyClaim is the name of the JWT claim containing the user groups.
+	// CompanyClaim is the name of the JWT claim containing the user company.
 	// +optional
 	CompanyClaim string `json:"companyClaim,omitempty"`
 }

diff --git a/pkg/apis/hub/v1alpha1/crd/hub.traefik.io_apiportals.yaml b/pkg/apis/hub/v1alpha1/crd/hub.traefik.io_apiportals.yaml
@@ -83,12 +83,16 @@ spec:
                     type: string
                   companyClaim:
                     description: CompanyClaim is the name of the JWT claim containing
-                      the user groups.
+                      the user company.
                     type: string
                   emailClaim:
                     description: EmailClaim is the name of the JWT claim containing
                       the user email.
                     type: string
+                  externalIdClaim:
+                    description: ExternalIDClaim is the name of the JWT claim containing
+                      the user external ID.
+                    type: string
                   firstnameClaim:
                     description: FirstnameClaim is the name of the JWT claim containing
                       the user firstname.