feat: Add the ability to add client roles to KeycloakRealmUser (#135)

Author: zmotso

api/v1/keycloakclient_types.go

@@ -219,7 +219,7 @@ type ClientRole struct {
 	// ClientID is a client ID.
 	ClientID string `json:"clientId"`
 
-	// Roles is a list of client roles names assigned to service account.
+	// Roles is a list of client roles names assigned to user.
 	// +nullable
 	// +optional
 	Roles []string `json:"roles,omitempty"`

api/v1/keycloakrealmuser_types.go

@@ -45,6 +45,11 @@ type KeycloakRealmUserSpec struct {
 	// +optional
 	Roles []string `json:"roles,omitempty"`
 
+	// ClientRoles is a list of client roles assigned to user.
+	// +nullable
+	// +optional
+	ClientRoles []ClientRole `json:"clientRoles,omitempty"`
+
 	// Groups is a list of groups assigned to user.
 	// +nullable
 	// +optional

api/v1/zz_generated.deepcopy.go

@@ -600,7 +600,7 @@ spec:
                           type: string
                         roles:
                           description: Roles is a list of client roles names assigned
-                            to service account.
+                            to user.
                           items:
                             type: string
                           nullable: true

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

@@ -67,7 +67,7 @@ spec:
                       type: string
                     roles:
                       description: Roles is a list of client roles names assigned
-                        to service account.
+                        to user.
                       items:
                         type: string
                       nullable: true

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

@@ -50,6 +50,25 @@ spec:
                 description: Attributes is a map of user attributes.
                 nullable: true
                 type: object
+              clientRoles:
+                description: ClientRoles is a list of client roles assigned to user.
+                items:
+                  properties:
+                    clientId:
+                      description: ClientID is a client ID.
+                      type: string
+                    roles:
+                      description: Roles is a list of client roles names assigned
+                        to user.
+                      items:
+                        type: string
+                      nullable: true
+                      type: array
+                  required:
+                  - clientId
+                  type: object
+                nullable: true
+                type: array
               email:
                 description: Email is a user email.
                 type: string

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

@@ -600,7 +600,7 @@ spec:
                           type: string
                         roles:
                           description: Roles is a list of client roles names assigned
-                            to service account.
+                            to user.
                           items:
                             type: string
                           nullable: true

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

@@ -67,7 +67,7 @@ spec:
                       type: string
                     roles:
                       description: Roles is a list of client roles names assigned
-                        to service account.
+                        to user.
                       items:
                         type: string
                       nullable: true

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

@@ -50,6 +50,25 @@ spec:
                 description: Attributes is a map of user attributes.
                 nullable: true
                 type: object
+              clientRoles:
+                description: ClientRoles is a list of client roles assigned to user.
+                items:
+                  properties:
+                    clientId:
+                      description: ClientID is a client ID.
+                      type: string
+                    roles:
+                      description: Roles is a list of client roles names assigned
+                        to user.
+                      items:
+                        type: string
+                      nullable: true
+                      type: array
+                  required:
+                  - clientId
+                  type: object
+                nullable: true
+                type: array
               email:
                 description: Email is a user email.
                 type: string

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

@@ -3153,7 +3153,7 @@ ServiceAccount is a service account configuration.
         <td><b>roles</b></td>
         <td>[]string</td>
         <td>
-          Roles is a list of client roles names assigned to service account.<br/>
+          Roles is a list of client roles names assigned to user.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -3876,7 +3876,7 @@ RealmRef is reference to Realm custom resource.
         <td><b>roles</b></td>
         <td>[]string</td>
         <td>
-          Roles is a list of client roles names assigned to service account.<br/>
+          Roles is a list of client roles names assigned to user.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -6108,6 +6108,13 @@ KeycloakRealmUserSpec defines the desired state of KeycloakRealmUser.
           Attributes is a map of user attributes.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b><a href="#keycloakrealmuserspecclientrolesindex">clientRoles</a></b></td>
+        <td>[]object</td>
+        <td>
+          ClientRoles is a list of client roles assigned to user.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>email</b></td>
         <td>string</td>
@@ -6247,6 +6254,40 @@ RealmRef is reference to Realm custom resource.
 </table>
 
 
+### KeycloakRealmUser.spec.clientRoles[index]
+<sup><sup>[↩ Parent](#keycloakrealmuserspec)</sup></sup>
+
+
+
+
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>clientId</b></td>
+        <td>string</td>
+        <td>
+          ClientID is a client ID.<br/>
+        </td>
+        <td>true</td>
+      </tr><tr>
+        <td><b>roles</b></td>
+        <td>[]string</td>
+        <td>
+          Roles is a list of client roles names assigned to user.<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>
+
+
 ### KeycloakRealmUser.spec.passwordSecret
 <sup><sup>[↩ Parent](#keycloakrealmuserspec)</sup></sup>