Package org.keycloak.organization.admin.resource

Class OrganizationGroupResource

java.lang.Object

org.keycloak.organization.admin.resource.OrganizationGroupResource

public class OrganizationGroupResource
extends Object

Constructor Summary

Constructors

Constructor	Description
OrganizationGroupResource(KeycloakSession session, OrganizationProvider organizationProvider, OrganizationModel organization, GroupModel group, AdminEventBuilder adminEvent, AdminPermissionEvaluator auth)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addSubGroup(GroupRepresentation rep)
void	deleteGroup()
GroupRepresentation	getGroup(boolean subGroupsCount)	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization), and then through OrganizationGroupsResource.getGroupById(String) which enforces the same check.
Stream<MemberRepresentation>	getMembers(Integer firstResult, Integer maxResults, Boolean briefRepresentation)	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization), and then through OrganizationGroupsResource.getGroupById(String) which enforces the same check.
RoleMapperResource	getRoleMappings()
Stream<GroupRepresentation>	getSubGroups(String search, Boolean exact, Integer first, Integer max, boolean subGroupsCount)	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization), and then through OrganizationGroupsResource.getGroupById(String) which enforces the same check.
void	joinGroup(String userId)
void	leaveGroup(String userId)
jakarta.ws.rs.core.Response	updateGroup(GroupRepresentation rep)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrganizationGroupResource

public OrganizationGroupResource(KeycloakSession session,
 OrganizationProvider organizationProvider,
 OrganizationModel organization,
 GroupModel group,
 AdminEventBuilder adminEvent,
 AdminPermissionEvaluator auth)

Method Details

getGroup

@GET
@Produces("application/json")
public GroupRepresentation getGroup(@QueryParam("subGroupsCount") @DefaultValue("false")
 boolean subGroupsCount)

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization), and then through OrganizationGroupsResource.getGroupById(String) which enforces the same check.

getRoleMappings

@Path("role-mappings")
public RoleMapperResource getRoleMappings()

deleteGroup

@DELETE
public void deleteGroup()

updateGroup

@PUT
@Consumes("application/json")
public jakarta.ws.rs.core.Response updateGroup(GroupRepresentation rep)

getSubGroups

@GET
@Path("children")
@Produces("application/json")
public Stream<GroupRepresentation> getSubGroups(@QueryParam("search")
 String search,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first") @DefaultValue("0")
 Integer first,
 @QueryParam("max") @DefaultValue("10")
 Integer max,
 @QueryParam("subGroupsCount")
 boolean subGroupsCount)

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization), and then through OrganizationGroupsResource.getGroupById(String) which enforces the same check.

addSubGroup

@POST
@Path("children")
@Produces("application/json")
@Consumes("application/json")
public jakarta.ws.rs.core.Response addSubGroup(GroupRepresentation rep)

getMembers

@GET
@Path("members")
@Produces("application/json")
public Stream<MemberRepresentation> getMembers(@QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation)

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization), and then through OrganizationGroupsResource.getGroupById(String) which enforces the same check. This method additionally requires auth.users().requireQuery().

joinGroup

@PUT
@Path("members/{userId}")
public void joinGroup(@PathParam("userId")
 String userId)

leaveGroup

@DELETE
@Path("members/{userId}")
public void leaveGroup(@PathParam("userId")
 String userId)