Package org.keycloak.admin.client.resource

Interface OrganizationGroupResource

public interface OrganizationGroupResource

Resource for managing a single organization group.

Method Summary

Modifier and Type	Method	Description
void	addMember(String userId)
jakarta.ws.rs.core.Response	addSubGroup(org.keycloak.representations.idm.GroupRepresentation rep)
void	delete()
List<org.keycloak.representations.idm.MemberRepresentation>	getMembers(Integer first, Integer max, Boolean briefRepresentation)
List<org.keycloak.representations.idm.GroupRepresentation>	getSubGroups(String search, Boolean exact, Integer first, Integer max)
void	removeMember(String userId)
org.keycloak.representations.idm.GroupRepresentation	toRepresentation(boolean subGroupsCount)
jakarta.ws.rs.core.Response	update(org.keycloak.representations.idm.GroupRepresentation rep)

Method Details

toRepresentation

@GET
@Produces("application/json")
org.keycloak.representations.idm.GroupRepresentation toRepresentation(@QueryParam("subGroupsCount")
 boolean subGroupsCount)

update

@PUT
@Consumes("application/json")
jakarta.ws.rs.core.Response update(org.keycloak.representations.idm.GroupRepresentation rep)

delete

@DELETE
void delete()

getSubGroups

@GET
@Path("children")
@Produces("application/json")
List<org.keycloak.representations.idm.GroupRepresentation> getSubGroups(@QueryParam("search")
 String search,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

addSubGroup

@POST
@Path("children")
@Consumes("application/json")
jakarta.ws.rs.core.Response addSubGroup(org.keycloak.representations.idm.GroupRepresentation rep)

getMembers

@GET
@Path("members")
@Produces("application/json")
List<org.keycloak.representations.idm.MemberRepresentation> getMembers(@QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation)

addMember

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

removeMember

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