libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

KEYCLOAK-10712 get groups full representation endpoint

Browse source
This commit is contained in:
Axel Messinese 2019-06-26 08:12:34 +02:00 committed by Stian Thorgersen
parent 66de87a211
commit f3607fd74d
4 changed files with 65 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/GroupsResource.java
View file

@ -68,6 +68,22 @@ public interface GroupsResource {
@QueryParam("first") Integer first, @QueryParam("first") Integer first,
@QueryParam("max") Integer max); @QueryParam("max") Integer max);
/**
* Get groups by pagination params.
* @param search max number of occurrences
* @param first index of the first element
* @param max max number of occurrences
* @param fullRepresentation if true, return groups with their attributes
* @return A list containing the slice of all groups.
*/
@GET
@NoCache
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
List<GroupRepresentation> groups(@QueryParam("search") String search,
@QueryParam("first") Integer first,
@QueryParam("max") Integer max,
@QueryParam("full") @DefaultValue("false") boolean fullRepresentation);
/** /**
* Counts all groups. * Counts all groups.
* @return A map containing key "count" with number of groups as value. * @return A map containing key "count" with number of groups as value.

4
server-spi-private/src/main/java/org/keycloak/models/utils/ModelToRepresentation.java
View file

@ -95,12 +95,12 @@ public class ModelToRepresentation {
return rep; return rep;
} }
public static List<GroupRepresentation> searchForGroupByName(RealmModel realm, String search, Integer first, Integer max) { public static List<GroupRepresentation> searchForGroupByName(RealmModel realm, boolean full, String search, Integer first, Integer max) {
List<GroupRepresentation> result = new LinkedList<>(); List<GroupRepresentation> result = new LinkedList<>();
List<GroupModel> groups = realm.searchForGroupByName(search, first, max); List<GroupModel> groups = realm.searchForGroupByName(search, first, max);
if (Objects.isNull(groups)) return result; if (Objects.isNull(groups)) return result;
for (GroupModel group : groups) { for (GroupModel group : groups) {
GroupRepresentation rep = toGroupHierarchy(group, false); GroupRepresentation rep = toGroupHierarchy(group, full);
result.add(rep); result.add(rep);
} }
return result; return result;

11
services/src/main/java/org/keycloak/services/resources/admin/GroupsResource.java
View file

@ -74,17 +74,18 @@ public class GroupsResource {
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
public List<GroupRepresentation> getGroups(@QueryParam("search") String search, public List<GroupRepresentation> getGroups(@QueryParam("search") String search,
@QueryParam("first") Integer firstResult, @QueryParam("first") Integer firstResult,
@QueryParam("max") Integer maxResults) { @QueryParam("max") Integer maxResults,
@QueryParam("full") @DefaultValue("false") boolean fullRepresentation) {
auth.groups().requireList(); auth.groups().requireList();
List<GroupRepresentation> results; List<GroupRepresentation> results;
if (Objects.nonNull(search)) { if (Objects.nonNull(search)) {
results = ModelToRepresentation.searchForGroupByName(realm, search.trim(), firstResult, maxResults); results = ModelToRepresentation.searchForGroupByName(realm, fullRepresentation, search.trim(), firstResult, maxResults);
} else if(Objects.nonNull(firstResult) && Objects.nonNull(maxResults)) { } else if(Objects.nonNull(firstResult) && Objects.nonNull(maxResults)) {
results = ModelToRepresentation.toGroupHierarchy(realm, false, firstResult, maxResults); results = ModelToRepresentation.toGroupHierarchy(realm, fullRepresentation, firstResult, maxResults);
} else { } else {
results = ModelToRepresentation.toGroupHierarchy(realm, false); results = ModelToRepresentation.toGroupHierarchy(realm, fullRepresentation);
} }
return results; return results;
@ -140,7 +141,7 @@ public class GroupsResource {
public Response addTopLevelGroup(GroupRepresentation rep) { public Response addTopLevelGroup(GroupRepresentation rep) {
auth.groups().requireManage(); auth.groups().requireManage();
List<GroupRepresentation> search = ModelToRepresentation.searchForGroupByName(realm, rep.getName(), 0, 1); List<GroupRepresentation> search = ModelToRepresentation.searchForGroupByName(realm, false, rep.getName(), 0, 1);
if (search != null && !search.isEmpty() && Objects.equals(search.get(0).getName(), rep.getName())) { if (search != null && !search.isEmpty() && Objects.equals(search.get(0).getName(), rep.getName())) {
return ErrorResponse.exists("Top level group named '" + rep.getName() + "' already exists."); return ErrorResponse.exists("Top level group named '" + rep.getName() + "' already exists.");
} }

41
testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/group/GroupTest.java
View file

@ -52,9 +52,12 @@ import javax.ws.rs.core.Response;
import java.io.IOException; import java.io.IOException;
import java.net.URI; import java.net.URI;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList; import java.util.LinkedList;
import java.util.List; import java.util.List;
import java.util.Map;
import java.util.UUID; import java.util.UUID;
import javax.ws.rs.ClientErrorException; import javax.ws.rs.ClientErrorException;
import javax.ws.rs.core.Response.Status; import javax.ws.rs.core.Response.Status;
@ -671,6 +674,44 @@ public class GroupTest extends AbstractGroupTest {
assertEquals(110, group.members(-1, -2).size()); assertEquals(110, group.members(-1, -2).size());
} }
} }
@Test
public void getGroupsWithFullRepresentation() {
RealmResource realm = adminClient.realms().realm("test");
GroupsResource groupsResource = adminClient.realms().realm("test").groups();
GroupRepresentation group = new GroupRepresentation();
group.setName("groupWithAttribute");
Map<String, List<String>> attributes = new HashMap<String, List<String>>();
attributes.put("attribute1", Arrays.asList("attribute1","attribute2"));
group.setAttributes(attributes);
group = createGroup(realm, group);
List<GroupRepresentation> groups = groupsResource.groups("groupWithAttribute", 0, 20, true);
assertFalse(groups.isEmpty());
assertTrue(groups.get(0).getAttributes().containsKey("attribute1"));
}
@Test
public void getGroupsWithBriefRepresentation() {
RealmResource realm = adminClient.realms().realm("test");
GroupsResource groupsResource = adminClient.realms().realm("test").groups();
GroupRepresentation group = new GroupRepresentation();
group.setName("groupWithAttribute");
Map<String, List<String>> attributes = new HashMap<String, List<String>>();
attributes.put("attribute1", Arrays.asList("attribute1","attribute2"));
group.setAttributes(attributes);
group = createGroup(realm, group);
List<GroupRepresentation> groups = groupsResource.groups("groupWithAttribute", 0, 20);
assertFalse(groups.isEmpty());
assertNull(groups.get(0).getAttributes());
}
@Test @Test
public void searchAndCountGroups() throws Exception { public void searchAndCountGroups() throws Exception {