Package org.keycloak.services.resources.admin

Class GroupResource

  • public class GroupResource
extends Object
    Author:
    Bill Burke

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response addChild​(org.keycloak.representations.idm.GroupRepresentation rep)
      Set or create child.
      void deleteGroup()  
      org.keycloak.representations.idm.GroupRepresentation getGroup()  
      org.keycloak.representations.idm.ManagementPermissionReference getManagementPermissions()
      Return object stating whether client Authorization permissions have been initialized or not and a reference
      Stream<org.keycloak.representations.idm.UserRepresentation> getMembers​(Integer firstResult, Integer maxResults, Boolean briefRepresentation)
      Get users Returns a stream of users, filtered according to query parameters
      RoleMapperResource getRoleMappings()  
      org.keycloak.representations.idm.ManagementPermissionReference setManagementPermissionsEnabled​(org.keycloak.representations.idm.ManagementPermissionReference ref)
      Return object stating whether client Authorization permissions have been initialized or not and a reference
      static org.keycloak.representations.idm.ManagementPermissionReference toMgmtRef​(org.keycloak.models.GroupModel group, AdminPermissionManagement permissions)  
      javax.ws.rs.core.Response updateGroup​(org.keycloak.representations.idm.GroupRepresentation rep)
      Update group, ignores subgroups.
      static void updateGroup​(org.keycloak.representations.idm.GroupRepresentation rep, org.keycloak.models.GroupModel model, org.keycloak.models.RealmModel realm, org.keycloak.models.KeycloakSession session)  

    • Constructor Detail

      • GroupResource

        public GroupResource​(org.keycloak.models.RealmModel realm,
                     org.keycloak.models.GroupModel group,
                     org.keycloak.models.KeycloakSession session,
                     AdminPermissionEvaluator auth,
                     AdminEventBuilder adminEvent)

    • Method Detail

      • getGroup

        @GET
@Produces("application/json")
public org.keycloak.representations.idm.GroupRepresentation getGroup()
        Returns:

      • updateGroup

        @PUT
@Consumes("application/json")
public javax.ws.rs.core.Response updateGroup​(org.keycloak.representations.idm.GroupRepresentation rep)
        Update group, ignores subgroups.
        Parameters:
        rep -

      • deleteGroup

        @DELETE
public void deleteGroup()

      • addChild

        @POST
@Path("children")
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response addChild​(org.keycloak.representations.idm.GroupRepresentation rep)
        Set or create child. This will just set the parent if it exists. Create it and set the parent if the group doesn't exist.
        Parameters:
        rep -

      • updateGroup

        public static void updateGroup​(org.keycloak.representations.idm.GroupRepresentation rep,
                               org.keycloak.models.GroupModel model,
                               org.keycloak.models.RealmModel realm,
                               org.keycloak.models.KeycloakSession session)

      • getMembers

        @GET
@Path("members")
@Produces("application/json")
public Stream<org.keycloak.representations.idm.UserRepresentation> getMembers​(@QueryParam("first")
                                                                              Integer firstResult,
                                                                              @QueryParam("max")
                                                                              Integer maxResults,
                                                                              @QueryParam("briefRepresentation")
                                                                              Boolean briefRepresentation)
        Get users Returns a stream of users, filtered according to query parameters
        Parameters:
        firstResult - Pagination offset
        maxResults - Maximum results size (defaults to 100)
        briefRepresentation - Only return basic information (only guaranteed to return id, username, created, first and last name, email, enabled state, email verification state, federation link, and access. Note that it means that namely user attributes, required actions, and not before are not returned.)
        Returns:
        a non-null Stream of users

      • getManagementPermissions

        @Path("management/permissions")
@GET
@Produces("application/json")
public org.keycloak.representations.idm.ManagementPermissionReference getManagementPermissions()
        Return object stating whether client Authorization permissions have been initialized or not and a reference
        Returns:

      • toMgmtRef

        public static org.keycloak.representations.idm.ManagementPermissionReference toMgmtRef​(org.keycloak.models.GroupModel group,
                                                                                       AdminPermissionManagement permissions)

      • setManagementPermissionsEnabled

        @Path("management/permissions")
@PUT
@Produces("application/json")
@Consumes("application/json")
public org.keycloak.representations.idm.ManagementPermissionReference setManagementPermissionsEnabled​(org.keycloak.representations.idm.ManagementPermissionReference ref)
        Return object stating whether client Authorization permissions have been initialized or not and a reference
        Returns:
        initialized manage permissions reference