feat: Add displayHTMLName to realm resource

feat: Add displayHTMLName to realm resource

feat: Add displayHTMLName to realm resource

Author: Douglass Kirkley

api/v1/keycloakrealm_types.go

@@ -56,6 +56,10 @@ type KeycloakRealmSpec struct {
 	// +optional
 	PasswordPolicies []PasswordPolicy `json:"passwordPolicy,omitempty"`
 
+	// DisplayHTMlName name to render in the UI
+	// +optional
+	DisplayHTMLName string `json:"displayHtmlName,omitempty"`
+
 	// FrontendURL Set the frontend URL for the realm. Use in combination with the default hostname provider to override the base URL for frontend requests for a specific realm.
 	// +optional
 	FrontendURL string `json:"frontendUrl,omitempty"`

config/crd/bases/v1.edp.epam.com_keycloakrealms.yaml

@@ -60,6 +60,9 @@ spec:
                   apply to HTTP responses from the realm's browser clients.
                 nullable: true
                 type: object
+              displayHtmlName:
+                description: DisplayHTMlName name to display via the frontend
+                type: string
               frontendUrl:
                 description: FrontendURL Set the frontend URL for the realm. Use in
                   combination with the default hostname provider to override the base

controllers/keycloakrealm/chain/realm_settings.go

@@ -38,7 +38,8 @@ func (h RealmSettings) ServeRequest(ctx context.Context, realm *keycloakApi.Keyc
 	}
 
 	settings := adapter.RealmSettings{
-		FrontendURL: realm.Spec.FrontendURL,
+		DisplayHTMLName: realm.Spec.DisplayHTMLName,
+		FrontendURL:     realm.Spec.FrontendURL,
 	}
 
 	if realm.Spec.Themes != nil {

controllers/keycloakrealm/chain/realm_settings_test.go

@@ -39,7 +39,8 @@ func TestRealmSettings_ServeRequest(t *testing.T) {
 			PasswordPolicies: []keycloakApi.PasswordPolicy{
 				{Type: "foo", Value: "bar"},
 			},
-			FrontendURL: "http://example.com",
+			DisplayHTMLName: "<div class=\"kc-logo-text\"><span>Example</span></div>",
+			FrontendURL:     "http://example.com",
 		},
 	}
 
@@ -53,7 +54,8 @@ func TestRealmSettings_ServeRequest(t *testing.T) {
 		PasswordPolicies: []adapter.PasswordPolicy{
 			{Type: "foo", Value: "bar"},
 		},
-		FrontendURL: realm.Spec.FrontendURL,
+		DisplayHTMLName: realm.Spec.DisplayHTMLName,
+		FrontendURL:     realm.Spec.FrontendURL,
 	}).Return(nil)
 
 	kClient.On("SetRealmEventConfig", realm.Spec.RealmName, &adapter.RealmEventConfig{

deploy-templates/crds/v1.edp.epam.com_keycloakrealms.yaml

@@ -60,6 +60,9 @@ spec:
                   apply to HTTP responses from the realm's browser clients.
                 nullable: true
                 type: object
+              displayHtmlName:
+                description: DisplayHTMlName name to display via the frontend
+                type: string
               frontendUrl:
                 description: FrontendURL Set the frontend URL for the realm. Use in
                   combination with the default hostname provider to override the base

docs/api.md

@@ -6525,6 +6525,13 @@ KeycloakRealmSpec defines the desired state of KeycloakRealm.
           BrowserSecurityHeaders is a map of security headers to apply to HTTP responses from the realm's browser clients.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>displayHtmlName</b></td>
+        <td>string</td>
+        <td>
+          DisplayHTMlName name to display via the frontend<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>frontendUrl</b></td>
         <td>string</td>

pkg/client/keycloak/adapter/gocloak_adapter_realms.go

@@ -18,6 +18,7 @@ type RealmSettings struct {
 	Themes                 *RealmThemes
 	BrowserSecurityHeaders *map[string]string
 	PasswordPolicies       []PasswordPolicy
+	DisplayHTMLName        string
 	FrontendURL            string
 	TokenSettings          *TokenSettings
 }
@@ -93,6 +94,14 @@ func setRealmSettings(realm *gocloak.RealmRepresentation, realmSettings *RealmSe
 		realm.PasswordPolicy = gocloak.StringP(strings.Join(policies, " and "))
 	}
 
+	if realmSettings.DisplayHTMLName != "" {
+		if realm.Attributes == nil {
+			realm.Attributes = &map[string]string{}
+		}
+
+		(*realm.Attributes)["displayHTMLName"] = realmSettings.DisplayHTMLName
+	}
+
 	if realmSettings.FrontendURL != "" {
 		if realm.Attributes == nil {
 			realm.Attributes = &map[string]string{}