keycloak · pedroigor · Jul 25, 2024 · Jul 18, 2024 · Jul 23, 2024
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2024 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.keycloak.representations.idm;
+
+public class MemberRepresentation extends UserRepresentation {
+
+    private MembershipType membershipType;
+
+    public MemberRepresentation() {
+        super();
+    }
+
+    public MemberRepresentation(UserRepresentation user) {
+        super(user);
+    }
+
+    public MembershipType getMembershipType() {
+        return membershipType;
+    }
+
+    public void setMembershipType(MembershipType membershipType) {
+        this.membershipType = membershipType;
+    }
+}
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2024 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.keycloak.representations.idm;
+
+public enum MembershipType {
+
+    /**
+     * Indicates that member can exist without group/organization.
+     */
+    UNMANAGED,
+
+    /**
+     * Indicates that member cannot exist without group/organization.
+     */
+    MANAGED;
+}
@@ -34,7 +34,7 @@ public class OrganizationRepresentation {
     private String description;
     private Map<String, List<String>> attributes;
     private Set<OrganizationDomainRepresentation> domains;
-    private List<UserRepresentation> members;
+    private List<MemberRepresentation> members;
     private List<IdentityProviderRepresentation> identityProviders;
 
     public String getId() {
@@ -119,19 +119,19 @@ public void removeDomain(OrganizationDomainRepresentation domain) {
         getDomains().remove(domain);
     }
 
-    public List<UserRepresentation> getMembers() {
+    public List<MemberRepresentation> getMembers() {
         return members;
     }
 
-    public void setMembers(List<UserRepresentation> members) {
+    public void setMembers(List<MemberRepresentation> members) {
         this.members = members;
     }
 
-    public void addMember(UserRepresentation user) {
+    public void addMember(MemberRepresentation member) {
         if (members == null) {
             members = new ArrayList<>();
         }
-        members.add(user);
+        members.add(member);
     }
 
     public List<IdentityProviderRepresentation> getIdentityProviders() {

@@ -52,6 +52,43 @@ public class UserRepresentation extends AbstractUserRepresentation{
     protected List<String> groups;
     private Map<String, Boolean> access;
 
+    public UserRepresentation() {
+    }
+
+    public UserRepresentation(UserRepresentation rep) {
+        // AbstractUserRepresentation
+        this.id = rep.getId();
+        this.username = rep.getUsername();
+        this.firstName = rep.getFirstName();
+        this.lastName = rep.getLastName();
+        this.email = rep.getEmail();
+        this.emailVerified = rep.isEmailVerified();
+        this.attributes = rep.getAttributes();
+        this.setUserProfileMetadata(rep.getUserProfileMetadata());
+
+        this.self = rep.getSelf();
+        this.origin = rep.getOrigin();
+        this.createdTimestamp = rep.getCreatedTimestamp();
+        this.enabled = rep.isEnabled();
+        this.totp = rep.isTotp();
+        this.federationLink = rep.getFederationLink();
+        this.serviceAccountClientId = rep.getServiceAccountClientId();
+        this.credentials = rep.getCredentials();
+        this.disableableCredentialTypes = rep.getDisableableCredentialTypes();
+        this.requiredActions = rep.getRequiredActions();
+        this.federatedIdentities = rep.getFederatedIdentities();
+        this.realmRoles = rep.getRealmRoles();
+        this.clientRoles = rep.getClientRoles();
+        this.clientConsents = rep.getClientConsents();
+        this.notBefore = rep.getNotBefore();
+
+        this.applicationRoles = rep.getApplicationRoles();
+        this.socialLinks = rep.getSocialLinks();
+
+        this.groups = rep.getGroups();
+        this.access = rep.getAccess();
+    }
+
     public String getSelf() {
         return self;
     }

@@ -22,13 +22,13 @@
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
-import org.keycloak.representations.idm.UserRepresentation;
+import org.keycloak.representations.idm.MemberRepresentation;
 
 public interface OrganizationMemberResource {
 
     @GET
     @Produces(MediaType.APPLICATION_JSON)
-    UserRepresentation toRepresentation();
+    MemberRepresentation toRepresentation();
 
     @DELETE
     Response delete();

@@ -29,8 +29,8 @@
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import org.keycloak.representations.idm.MemberRepresentation;
 import org.keycloak.representations.idm.OrganizationRepresentation;
-import org.keycloak.representations.idm.UserRepresentation;
 
 public interface OrganizationMembersResource {
 
@@ -45,7 +45,7 @@ public interface OrganizationMembersResource {
      */
     @GET
     @Produces(MediaType.APPLICATION_JSON)
-    List<UserRepresentation> getAll();
+    List<MemberRepresentation> getAll();
 
     /**
      * Return all organization members that match the specified filters.
@@ -60,7 +60,7 @@ public interface OrganizationMembersResource {
      */
     @GET
     @Produces(MediaType.APPLICATION_JSON)
-    List<UserRepresentation> search(
+    List<MemberRepresentation> search(
             @QueryParam("search") String search,
             @QueryParam("exact") Boolean exact,
             @QueryParam("first") Integer first,

@@ -21,6 +21,7 @@
 import java.util.stream.Stream;
 import org.keycloak.models.IdentityProviderModel;
 import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.MembershipMetadata;
 import org.keycloak.models.OrganizationModel;
 import org.keycloak.models.RealmModel;
 import org.keycloak.models.UserModel;
@@ -134,6 +135,11 @@ public void removeAll() {
         getAllStream().forEach(this::remove);
     }
 
+    @Override
+    public boolean addManagedMember(OrganizationModel organization, UserModel user) {
+        return orgDelegate.addManagedMember(organization, user);
+    }
+
     @Override
     public boolean addMember(OrganizationModel organization, UserModel user) {
         return orgDelegate.addMember(organization, user);

@@ -26,6 +26,7 @@
 import org.keycloak.models.GroupModel;
 import org.keycloak.models.GroupModel.GroupMemberJoinEvent;
 import org.keycloak.models.GroupModel.GroupMemberLeaveEvent;
+import org.keycloak.models.MembershipMetadata;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.RealmModel;
 import org.keycloak.models.RoleModel;
@@ -55,6 +56,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.stream.Stream;
+import org.keycloak.representations.idm.MembershipType;
 
 import static org.keycloak.utils.StreamsUtil.closing;
 
@@ -167,7 +169,7 @@ public void setSingleAttribute(String name, String value) {
 
     @Override
     public void setAttribute(String name, List<String> values) {
-        String valueToSet = (values != null && values.size() > 0) ? values.get(0) : null;
+        String valueToSet = (values != null && !values.isEmpty()) ? values.get(0) : null;
         if (UserModel.FIRST_NAME.equals(name)) {
             user.setFirstName(valueToSet);
             return;
@@ -363,7 +365,7 @@ private TypedQuery<String> createGetGroupsQuery() {
         predicates.add(builder.equal(root.get("user"), getEntity()));
 
         queryBuilder.select(root.get("groupId"));
-        queryBuilder.where(predicates.toArray(new Predicate[0]));
+        queryBuilder.where(predicates.toArray(Predicate[]::new));
 
         return em.createQuery(queryBuilder);
     }
@@ -414,20 +416,28 @@ public long getGroupsCountByNameContaining(String search) {
 
     @Override
     public void joinGroup(GroupModel group) {
-        if (RoleUtils.isDirectMember(getGroupsStream(), group)) return;
-        joinGroupImpl(group);
+        joinGroup(group, null);
+    }
 
+    @Override
+    public void joinGroup(GroupModel group, MembershipMetadata metadata) {
+        if (RoleUtils.isDirectMember(getGroupsStream(), group)) return;
+        joinGroupImpl(group, metadata);
     }
 
     protected void joinGroupImpl(GroupModel group) {
+        joinGroupImpl(group, null);
+    }
+
+    protected void joinGroupImpl(GroupModel group, MembershipMetadata metadata) {
         UserGroupMembershipEntity entity = new UserGroupMembershipEntity();
         entity.setUser(getEntity());
         entity.setGroupId(group.getId());
+        entity.setMembershipType(metadata == null ? MembershipType.UNMANAGED : metadata.getMembershipType());
         em.persist(entity);
         em.flush();
         em.detach(entity);
         GroupMemberJoinEvent.fire(group, session);
-
     }
 
     @Override
@@ -437,7 +447,7 @@ public void leaveGroup(GroupModel group) {
         TypedQuery<UserGroupMembershipEntity> query = getUserGroupMappingQuery(group);
         query.setLockMode(LockModeType.PESSIMISTIC_WRITE);
         List<UserGroupMembershipEntity> results = query.getResultList();
-        if (results.size() == 0) return;
+        if (results.isEmpty()) return;
         for (UserGroupMembershipEntity entity : results) {
             em.remove(entity);
         }
@@ -508,7 +518,7 @@ public void deleteRoleMapping(RoleModel role) {
         TypedQuery<UserRoleMappingEntity> query = getUserRoleMappingEntityTypedQuery(role);
         query.setLockMode(LockModeType.PESSIMISTIC_WRITE);
         List<UserRoleMappingEntity> results = query.getResultList();
-        if (results.size() == 0) return;
+        if (results.isEmpty()) return;
         for (UserRoleMappingEntity entity : results) {
             em.remove(entity);
         }

@@ -28,6 +28,7 @@
 import jakarta.persistence.NamedQuery;
 import jakarta.persistence.Table;
 import java.io.Serializable;
+import org.keycloak.representations.idm.MembershipType;
 
 /**
  * @author <a href="mailto:[email protected]">Bill Burke</a>
@@ -62,6 +63,9 @@ public class UserGroupMembershipEntity {
     @Column(name = "GROUP_ID")
     protected String groupId;
 
+    @Column(name = "MEMBERSHIP_TYPE")
+    private String membershipType;
+
     public UserEntity getUser() {
         return user;
     }
@@ -78,6 +82,14 @@ public void setGroupId(String groupId) {
         this.groupId = groupId;
     }
 
+    public MembershipType getMembershipType() {
+        return MembershipType.valueOf(membershipType);
+    }
+
+    public void setMembershipType(MembershipType membershipType) {
+        this.membershipType = membershipType.toString();
+    }
+
     public static class Key implements Serializable {
 
         protected UserEntity user;