## Uses of Class
org.keycloak.representations.idm.GroupRepresentation

- Packages that use GroupRepresentation
  Package | Description
  --- | ---
  org.keycloak.admin.client.resource |
  org.keycloak.models.utils |
  org.keycloak.partialimport |
  org.keycloak.representations.idm |
  org.keycloak.services.resources.admin |
  org.keycloak.utils |

- - ### Uses of GroupRepresentation in org.keycloak.admin.client.resource

    Methods in org.keycloak.admin.client.resource that return GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `GroupRepresentation` | RealmResource.`getGroupByPath(String path)`
    `GroupRepresentation` | GroupResource.`toRepresentation()` Does not expand hierarchy.

    Methods in org.keycloak.admin.client.resource that return types with arguments of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `List<GroupRepresentation>` | RealmResource.`getDefaultGroups()`
    `Set<GroupRepresentation>` | RoleResource.`getRoleGroupMembers()` Get role groups Returns groups that have the given role
    `Set<GroupRepresentation>` | RoleResource.`getRoleGroupMembers(Integer firstResult, Integer maxResults)` Get role groups Returns groups that have the given role, paginated according to the query parameters
    `List<GroupRepresentation>` | UserResource.`groups()`
    `List<GroupRepresentation>` | GroupsResource.`groups()` Get all groups.
    `List<GroupRepresentation>` | UserResource.`groups(Integer firstResult, Integer maxResults)`
    `List<GroupRepresentation>` | GroupsResource.`groups(Integer first, Integer max)` Get groups by pagination params.
    `List<GroupRepresentation>` | UserResource.`groups(Integer firstResult, Integer maxResults, boolean briefRepresentation)`
    `List<GroupRepresentation>` | UserResource.`groups(String search, Integer firstResult, Integer maxResults)`
    `List<GroupRepresentation>` | GroupsResource.`groups(String search, Integer first, Integer max)` Get groups by pagination params.
    `List<GroupRepresentation>` | UserResource.`groups(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)`
    `List<GroupRepresentation>` | GroupsResource.`groups(String search, Integer first, Integer max, boolean briefRepresentation)` Get groups by pagination params.

    Methods in org.keycloak.admin.client.resource with parameters of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | GroupsResource.`add(GroupRepresentation rep)` create or add a top level realm groupSet or create child.
    `javax.ws.rs.core.Response` | GroupResource.`subGroup(GroupRepresentation rep)` Set or create child.
    `void` | GroupResource.`update(GroupRepresentation rep)` Update group

  - ### Uses of GroupRepresentation in org.keycloak.models.utils

    Methods in org.keycloak.models.utils that return GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static GroupRepresentation` | ModelToRepresentation.`toGroupHierarchy(GroupModel group, boolean full)`
    `static GroupRepresentation` | ModelToRepresentation.`toRepresentation(GroupModel group, boolean full)`

    Methods in org.keycloak.models.utils that return types with arguments of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static Stream<GroupRepresentation>` | ModelToRepresentation.`searchForGroupByName(RealmModel realm, boolean full, String search, Integer first, Integer max)`
    `static Stream<GroupRepresentation>` | ModelToRepresentation.`searchForGroupByName(UserModel user, boolean full, String search, Integer first, Integer max)`
    `static Stream<GroupRepresentation>` | ModelToRepresentation.`toGroupHierarchy(RealmModel realm, boolean full)`
    `static Stream<GroupRepresentation>` | ModelToRepresentation.`toGroupHierarchy(RealmModel realm, boolean full, Integer first, Integer max)`
    `static Stream<GroupRepresentation>` | ModelToRepresentation.`toGroupHierarchy(UserModel user, boolean full)`
    `static Stream<GroupRepresentation>` | ModelToRepresentation.`toGroupHierarchy(UserModel user, boolean full, Integer first, Integer max)`

    Methods in org.keycloak.models.utils with parameters of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static void` | RepresentationToModel.`importGroup(RealmModel realm, GroupModel parent, GroupRepresentation group)`

  - ### Uses of GroupRepresentation in org.keycloak.partialimport

    Methods in org.keycloak.partialimport that return types with arguments of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `List<GroupRepresentation>` | GroupsPartialImport.`getRepList(PartialImportRepresentation partialImportRep)`

    Methods in org.keycloak.partialimport with parameters of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | GroupsPartialImport.`create(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)`
    `boolean` | GroupsPartialImport.`exists(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)`
    `String` | GroupsPartialImport.`existsMessage(RealmModel realm, GroupRepresentation groupRep)`
    `String` | GroupsPartialImport.`getModelId(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)`
    `String` | GroupsPartialImport.`getName(GroupRepresentation group)`
    `void` | GroupsPartialImport.`remove(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)`

  - ### Uses of GroupRepresentation in org.keycloak.representations.idm

    Fields in org.keycloak.representations.idm with type parameters of type GroupRepresentation
    Modifier and Type | Field and Description
    --- | ---
    `protected List<GroupRepresentation>` | RealmRepresentation.`groups`
    `protected List<GroupRepresentation>` | PartialImportRepresentation.`groups`
    `protected List<GroupRepresentation>` | GroupRepresentation.`subGroups`

    Methods in org.keycloak.representations.idm that return GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `GroupRepresentation` | GroupRepresentation.`singleAttribute(String name, String value)`

    Methods in org.keycloak.representations.idm that return types with arguments of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `List<GroupRepresentation>` | RealmRepresentation.`getGroups()`
    `List<GroupRepresentation>` | PartialImportRepresentation.`getGroups()`
    `List<GroupRepresentation>` | GroupRepresentation.`getSubGroups()`

    Method parameters in org.keycloak.representations.idm with type arguments of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmRepresentation.`setGroups(List<GroupRepresentation> groups)`
    `void` | PartialImportRepresentation.`setGroups(List<GroupRepresentation> groups)`
    `void` | GroupRepresentation.`setSubGroups(List<GroupRepresentation> subGroups)`

  - ### Uses of GroupRepresentation in org.keycloak.services.resources.admin

    Methods in org.keycloak.services.resources.admin that return GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `GroupRepresentation` | GroupResource.`getGroup()`
    `GroupRepresentation` | RealmAdminResource.`getGroupByPath(String path)`

    Methods in org.keycloak.services.resources.admin that return types with arguments of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `Stream<GroupRepresentation>` | RealmAdminResource.`getDefaultGroups()` Get group hierarchy.
    `Stream<GroupRepresentation>` | GroupsResource.`getGroups(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)` Get group hierarchy.
    `Stream<GroupRepresentation>` | RoleContainerResource.`getGroupsInRole(String roleName, Integer firstResult, Integer maxResults, boolean briefRepresentation)` Returns a stream of groups that have the specified role name
    `Stream<GroupRepresentation>` | UserResource.`groupMembership(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)`

    Methods in org.keycloak.services.resources.admin with parameters of type GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | GroupResource.`addChild(GroupRepresentation rep)` Set or create child.
    `javax.ws.rs.core.Response` | GroupsResource.`addTopLevelGroup(GroupRepresentation rep)` create or add a top level realm groupSet or create child.
    `javax.ws.rs.core.Response` | GroupResource.`updateGroup(GroupRepresentation rep)` Update group, ignores subgroups.
    `static void` | GroupResource.`updateGroup(GroupRepresentation rep, GroupModel model)`

  - ### Uses of GroupRepresentation in org.keycloak.utils

    Methods in org.keycloak.utils that return GroupRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static GroupRepresentation` | ServicesUtils.`groupToBriefRepresentation(GroupModel g)`

Copyright © 2021 JBoss by Red Hat. All rights reserved.