Uses of Interface
org.keycloak.models.GroupModel
-
-
Uses of GroupModel in org.keycloak.federation.kerberos
Methods in org.keycloak.federation.kerberos with parameters of type GroupModel Modifier and Type Method Description void
KerberosFederationProvider. preRemove(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.federation.sssd
Methods in org.keycloak.federation.sssd with parameters of type GroupModel Modifier and Type Method Description void
SSSDFederationProvider. preRemove(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.models
Subinterfaces of GroupModel in org.keycloak.models Modifier and Type Interface Description static interface
GroupModel.Streams
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directlyFields in org.keycloak.models with type parameters of type GroupModel Modifier and Type Field Description static SearchableModelField<GroupModel>
GroupModel.SearchableFields. ASSIGNED_ROLE
Field for comparison with roles granted to this group.static SearchableModelField<GroupModel>
GroupModel.SearchableFields. ATTRIBUTE
Search for attribute value.static Comparator<GroupModel>
GroupModel. COMPARE_BY_NAME
static SearchableModelField<GroupModel>
GroupModel.SearchableFields. ID
static SearchableModelField<GroupModel>
GroupModel.SearchableFields. NAME
static SearchableModelField<GroupModel>
GroupModel.SearchableFields. PARENT_ID
Parent group IDstatic SearchableModelField<GroupModel>
GroupModel.SearchableFields. REALM_ID
Methods in org.keycloak.models that return GroupModel Modifier and Type Method Description default GroupModel
GroupProvider. createGroup(RealmModel realm, String name)
Creates a new group with the given name in the given realm.default GroupModel
GroupProvider. createGroup(RealmModel realm, String id, String name)
Creates a new group with the given id and name in the given realm.GroupModel
GroupProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Creates a new group with the given name, id, name and parent to the given realm.default GroupModel
GroupProvider. createGroup(RealmModel realm, String name, GroupModel toParent)
Creates a new group with the given name and parent to the given realm.default GroupModel
RealmModel. createGroup(String name)
default GroupModel
RealmModel. createGroup(String id, String name)
GroupModel
RealmModel. createGroup(String id, String name, GroupModel toParent)
default GroupModel
RealmModel. createGroup(String name, GroupModel toParent)
default GroupModel
RealmProvider. createGroup(RealmModel realm, String name)
Deprecated.Use the corresponding method fromGroupProvider
.default GroupModel
RealmProvider. createGroup(RealmModel realm, String id, String name)
Deprecated.Use the corresponding method fromGroupProvider
.GroupModel
RealmProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Deprecated.Use the corresponding method fromGroupProvider
.default GroupModel
RealmProvider. createGroup(RealmModel realm, String name, GroupModel toParent)
Deprecated.Use the corresponding method fromGroupProvider
.GroupModel
GroupModel.GroupRemovedEvent. getGroup()
GroupModel
RealmModel. getGroupById(String id)
GroupModel
RealmProvider. getGroupById(RealmModel realm, String id)
Deprecated.Use the corresponding method fromGroupProvider
.GroupModel
GroupModel. getParent()
Methods in org.keycloak.models that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
RealmModel. getDefaultGroupsStream()
Returns default groups as a stream.Stream<GroupModel>
GroupProvider. getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Returns groups with the given role in the given realm.Stream<GroupModel>
GroupProvider. getGroupsStream(RealmModel realm)
Returns groups for the given realm.default Stream<GroupModel>
GroupProvider. getGroupsStream(RealmModel realm, Stream<String> ids)
Returns a stream of groups with given ids.default Stream<GroupModel>
GroupProvider. getGroupsStream(RealmModel realm, Stream<String> ids, Integer first, Integer max)
Returns a paginated stream of groups with given ids.Stream<GroupModel>
GroupProvider. getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Returns a paginated stream of groups with given ids and given search value in group names.Stream<GroupModel>
RealmModel. getGroupsStream()
Returns groups as a stream.Stream<GroupModel>
UserModel. getGroupsStream()
Obtains the groups associated with the user.default Stream<GroupModel>
UserModel. getGroupsStream(String search, Integer first, Integer max)
Returns a paginated stream of groups within this realm with search in the nameStream<GroupModel>
GroupModel. getSubGroupsStream()
Returns all sub groups for the parent group as a stream.Stream<GroupModel>
GroupProvider. getTopLevelGroupsStream(RealmModel realm)
Returns all top level groups (i.e.Stream<GroupModel>
GroupProvider. getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Returns top level groups (i.e.Stream<GroupModel>
RealmModel. getTopLevelGroupsStream()
Returns top level groups as a stream.Stream<GroupModel>
RealmModel. getTopLevelGroupsStream(Integer first, Integer max)
Returns top level groups as a stream.Stream<GroupModel>
RealmModel. searchForGroupByNameStream(String search, Integer first, Integer max)
Deprecated.Methods in org.keycloak.models with parameters of type GroupModel Modifier and Type Method Description void
GroupModel. addChild(GroupModel subGroup)
Automatically calls setParent() on the subGroupvoid
RealmModel. addDefaultGroup(GroupModel group)
void
GroupProvider. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
Removes parent group for the given group in the given realm.void
RealmProvider. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
Deprecated.Use the corresponding method fromGroupProvider
.GroupModel
GroupProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Creates a new group with the given name, id, name and parent to the given realm.default GroupModel
GroupProvider. createGroup(RealmModel realm, String name, GroupModel toParent)
Creates a new group with the given name and parent to the given realm.GroupModel
RealmModel. createGroup(String id, String name, GroupModel toParent)
default GroupModel
RealmModel. createGroup(String name, GroupModel toParent)
GroupModel
RealmProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Deprecated.Use the corresponding method fromGroupProvider
.default GroupModel
RealmProvider. createGroup(RealmModel realm, String name, GroupModel toParent)
Deprecated.Use the corresponding method fromGroupProvider
.boolean
UserModel. isMemberOf(GroupModel group)
void
UserModel. joinGroup(GroupModel group)
void
UserModel. leaveGroup(GroupModel group)
void
GroupProvider. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
This method is used for moving groups in group structure, for example: making an existing child group child group of some other group, setting a top level group (i.e.void
RealmModel. moveGroup(GroupModel group, GroupModel toParent)
void
RealmProvider. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
Deprecated.Use the corresponding method fromGroupProvider
.void
UserProvider. preRemove(RealmModel realm, GroupModel group)
Called when a group is removed.void
GroupModel. removeChild(GroupModel subGroup)
Automatically calls setParent() on the subGroupvoid
RealmModel. removeDefaultGroup(GroupModel group)
boolean
GroupProvider. removeGroup(RealmModel realm, GroupModel group)
Removes the given group for the given realm.boolean
RealmModel. removeGroup(GroupModel group)
boolean
RealmProvider. removeGroup(RealmModel realm, GroupModel group)
Deprecated.Use the corresponding method fromGroupProvider
.void
GroupModel. setParent(GroupModel group)
You must also call addChild on the parent group, addChild on RealmModel if there is no parent group -
Uses of GroupModel in org.keycloak.models.cache.infinispan
Classes in org.keycloak.models.cache.infinispan that implement GroupModel Modifier and Type Class Description class
GroupAdapter
Fields in org.keycloak.models.cache.infinispan declared as GroupModel Modifier and Type Field Description protected GroupModel
GroupAdapter. updated
Methods in org.keycloak.models.cache.infinispan that return GroupModel Modifier and Type Method Description GroupModel
RealmAdapter. createGroup(String id, String name, GroupModel toParent)
GroupModel
RealmCacheSession. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel
RealmAdapter. getGroupById(String id)
GroupModel
RealmCacheSession. getGroupById(RealmModel realm, String id)
GroupModel
GroupAdapter. getParent()
Methods in org.keycloak.models.cache.infinispan with parameters of type GroupModel Modifier and Type Method Description void
GroupAdapter. addChild(GroupModel subGroup)
void
RealmAdapter. addDefaultGroup(GroupModel group)
void
RealmCacheSession. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel
RealmAdapter. createGroup(String id, String name, GroupModel toParent)
GroupModel
RealmCacheSession. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Stream<UserModel>
UserCacheSession. getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>
UserCacheSession. getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
boolean
UserAdapter. isMemberOf(GroupModel group)
void
UserAdapter. joinGroup(GroupModel group)
void
UserAdapter. leaveGroup(GroupModel group)
void
RealmAdapter. moveGroup(GroupModel group, GroupModel toParent)
void
RealmCacheSession. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void
UserCacheSession. preRemove(RealmModel realm, GroupModel group)
void
GroupAdapter. removeChild(GroupModel subGroup)
void
RealmAdapter. removeDefaultGroup(GroupModel group)
boolean
RealmAdapter. removeGroup(GroupModel group)
boolean
RealmCacheSession. removeGroup(RealmModel realm, GroupModel group)
void
GroupAdapter. setParent(GroupModel group)
-
Uses of GroupModel in org.keycloak.models.cache.infinispan.entities
Method parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type GroupModel Modifier and Type Method Description MultivaluedHashMap<String,String>
CachedGroup. getAttributes(Supplier<GroupModel> group)
Set<String>
CachedGroup. getRoleMappings(Supplier<GroupModel> group)
Set<String>
CachedGroup. getSubGroups(Supplier<GroupModel> group)
Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type GroupModel Constructor Description CachedGroup(Long revision, RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.models.cache.infinispan.events
Methods in org.keycloak.models.cache.infinispan.events with parameters of type GroupModel Modifier and Type Method Description static GroupMovedEvent
GroupMovedEvent. create(GroupModel group, GroupModel toParent, String realmId)
static GroupRemovedEvent
GroupRemovedEvent. create(GroupModel group, String realmId)
-
Uses of GroupModel in org.keycloak.models.jpa
Classes in org.keycloak.models.jpa that implement GroupModel Modifier and Type Class Description class
GroupAdapter
Methods in org.keycloak.models.jpa that return GroupModel Modifier and Type Method Description GroupModel
JpaRealmProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel
RealmAdapter. createGroup(String id, String name, GroupModel toParent)
GroupModel
JpaRealmProvider. getGroupById(RealmModel realm, String id)
GroupModel
RealmAdapter. getGroupById(String id)
GroupModel
GroupAdapter. getParent()
Methods in org.keycloak.models.jpa with parameters of type GroupModel Modifier and Type Method Description void
GroupAdapter. addChild(GroupModel subGroup)
void
RealmAdapter. addDefaultGroup(GroupModel group)
void
JpaRealmProvider. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel
JpaRealmProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel
RealmAdapter. createGroup(String id, String name, GroupModel toParent)
Stream<UserModel>
JpaUserProvider. getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>
JpaUserProvider. getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
protected javax.persistence.TypedQuery<UserGroupMembershipEntity>
UserAdapter. getUserGroupMappingQuery(GroupModel group)
boolean
UserAdapter. isMemberOf(GroupModel group)
void
UserAdapter. joinGroup(GroupModel group)
protected void
UserAdapter. joinGroupImpl(GroupModel group)
void
UserAdapter. leaveGroup(GroupModel group)
void
JpaRealmProvider. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void
RealmAdapter. moveGroup(GroupModel group, GroupModel toParent)
void
JpaUserProvider. preRemove(RealmModel realm, GroupModel group)
void
GroupAdapter. removeChild(GroupModel subGroup)
void
RealmAdapter. removeDefaultGroup(GroupModel group)
boolean
JpaRealmProvider. removeGroup(RealmModel realm, GroupModel group)
boolean
RealmAdapter. removeGroup(GroupModel group)
void
GroupAdapter. setParent(GroupModel parent)
static GroupEntity
GroupAdapter. toEntity(GroupModel model, javax.persistence.EntityManager em)
-
Uses of GroupModel in org.keycloak.models.map.group
Classes in org.keycloak.models.map.group that implement GroupModel Modifier and Type Class Description class
AbstractGroupModel<E extends AbstractEntity>
class
MapGroupAdapter
Methods in org.keycloak.models.map.group that return GroupModel Modifier and Type Method Description GroupModel
MapGroupProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel
MapGroupProvider. getGroupById(RealmModel realm, String id)
GroupModel
MapGroupAdapter. getParent()
Methods in org.keycloak.models.map.group that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
MapGroupProvider. getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<GroupModel>
MapGroupProvider. getGroupsStream(RealmModel realm)
Stream<GroupModel>
MapGroupProvider. getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>
MapGroupProvider. getTopLevelGroupsStream(RealmModel realm)
Stream<GroupModel>
MapGroupProvider. getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<GroupModel>
MapGroupProvider. searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
Stream<GroupModel>
MapGroupProvider. searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Methods in org.keycloak.models.map.group with parameters of type GroupModel Modifier and Type Method Description void
MapGroupAdapter. addChild(GroupModel subGroup)
void
MapGroupProvider. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel
MapGroupProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
void
MapGroupProvider. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void
MapGroupAdapter. removeChild(GroupModel subGroup)
boolean
MapGroupProvider. removeGroup(RealmModel realm, GroupModel group)
void
MapGroupAdapter. setParent(GroupModel group)
Constructor parameters in org.keycloak.models.map.group with type arguments of type GroupModel Constructor Description MapGroupProvider(KeycloakSession session, MapStorage<MapGroupEntity,GroupModel> groupStore)
-
Uses of GroupModel in org.keycloak.models.map.realm
Methods in org.keycloak.models.map.realm that return GroupModel Modifier and Type Method Description GroupModel
MapRealmAdapter. createGroup(String id, String name, GroupModel toParent)
GroupModel
MapRealmProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Deprecated.GroupModel
MapRealmAdapter. getGroupById(String id)
GroupModel
MapRealmProvider. getGroupById(RealmModel realm, String id)
Deprecated.Methods in org.keycloak.models.map.realm with parameters of type GroupModel Modifier and Type Method Description void
MapRealmAdapter. addDefaultGroup(GroupModel group)
void
MapRealmProvider. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
Deprecated.GroupModel
MapRealmAdapter. createGroup(String id, String name, GroupModel toParent)
GroupModel
MapRealmProvider. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Deprecated.void
MapRealmAdapter. moveGroup(GroupModel group, GroupModel toParent)
void
MapRealmProvider. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
Deprecated.void
MapRealmAdapter. removeDefaultGroup(GroupModel group)
boolean
MapRealmAdapter. removeGroup(GroupModel group)
boolean
MapRealmProvider. removeGroup(RealmModel realm, GroupModel group)
Deprecated. -
Uses of GroupModel in org.keycloak.models.map.storage.chm
Fields in org.keycloak.models.map.storage.chm with type parameters of type GroupModel Modifier and Type Field Description static Map<SearchableModelField<GroupModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapGroupEntity,GroupModel>>
MapFieldPredicates. GROUP_PREDICATES
static Map<SearchableModelField<GroupModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapGroupEntity,GroupModel>>
MapFieldPredicates. GROUP_PREDICATES
-
Uses of GroupModel in org.keycloak.models.map.storage.jpa.group
Method parameters in org.keycloak.models.map.storage.jpa.group with type arguments of type GroupModel Modifier and Type Method Description JpaGroupModelCriteriaBuilder
JpaGroupModelCriteriaBuilder. compare(SearchableModelField<? super GroupModel> modelField, ModelCriteriaBuilder.Operator op, Object... value)
-
Uses of GroupModel in org.keycloak.models.map.user
Methods in org.keycloak.models.map.user that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
MapUserAdapter. getGroupsStream()
Methods in org.keycloak.models.map.user with parameters of type GroupModel Modifier and Type Method Description Stream<UserModel>
MapUserProvider. getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
boolean
MapUserAdapter. isMemberOf(GroupModel group)
void
MapUserAdapter. joinGroup(GroupModel group)
void
MapUserAdapter. leaveGroup(GroupModel group)
void
MapUserProvider. preRemove(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.models.utils
Methods in org.keycloak.models.utils that return GroupModel Modifier and Type Method Description static GroupModel
KeycloakModelUtils. findGroupByPath(RealmModel realm, String path)
Methods in org.keycloak.models.utils that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
UserModelDelegate. getGroupsStream()
Methods in org.keycloak.models.utils with parameters of type GroupModel Modifier and Type Method Description static String
KeycloakModelUtils. buildGroupPath(GroupModel group)
static String
KeycloakModelUtils. buildGroupPath(GroupModel group, GroupModel otherParentGroup)
static String
ModelToRepresentation. buildGroupPath(GroupModel group)
static GroupRepresentation
ModelToRepresentation. groupToBriefRepresentation(GroupModel g)
static boolean
RoleUtils. hasRoleFromGroup(GroupModel group, RoleModel targetRole, boolean checkParentGroup)
Checks whether thetargetRole
is contained in the given group or its parents (if requested)static void
RepresentationToModel. importGroup(RealmModel realm, GroupModel parent, GroupRepresentation group)
static boolean
RoleUtils. isDirectMember(Stream<GroupModel> groups, GroupModel targetGroup)
static boolean
RoleUtils. isMember(Stream<GroupModel> groups, GroupModel targetGroup)
boolean
UserModelDelegate. isMemberOf(GroupModel group)
void
ReadOnlyUserModelDelegate. joinGroup(GroupModel group)
void
UserModelDelegate. joinGroup(GroupModel group)
void
ReadOnlyUserModelDelegate. leaveGroup(GroupModel group)
void
UserModelDelegate. leaveGroup(GroupModel group)
static Collection<String>
KeycloakModelUtils. resolveAttribute(GroupModel group, String name, boolean aggregateAttrs)
static String
KeycloakModelUtils. resolveFirstAttribute(GroupModel group, String name)
static GroupRepresentation
ModelToRepresentation. toGroupHierarchy(GroupModel group, boolean full)
static GroupRepresentation
ModelToRepresentation. toGroupHierarchy(GroupModel group, boolean full, String search)
Deprecated.static GroupRepresentation
ModelToRepresentation. toGroupHierarchy(GroupModel group, boolean full, String search, Boolean exact)
static GroupRepresentation
ModelToRepresentation. toGroupHierarchy(GroupModel group, boolean full, Map<String,String> attributes)
static GroupRepresentation
ModelToRepresentation. toRepresentation(GroupModel group, boolean full)
Method parameters in org.keycloak.models.utils with type arguments of type GroupModel Modifier and Type Method Description static boolean
RoleUtils. hasRoleFromGroup(Stream<GroupModel> groups, RoleModel targetRole, boolean checkParentGroup)
Checks whether thetargetRole
is contained in any of thegroups
or their parents (if requested)static boolean
RoleUtils. isDirectMember(Stream<GroupModel> groups, GroupModel targetGroup)
static boolean
RoleUtils. isMember(Stream<GroupModel> groups, GroupModel targetGroup)
-
Uses of GroupModel in org.keycloak.protocol.saml.mappers
Methods in org.keycloak.protocol.saml.mappers with parameters of type GroupModel Modifier and Type Method Description String
SAMLGroupNameMapper. mapName(ProtocolMapperModel model, GroupModel group)
-
Uses of GroupModel in org.keycloak.services.resources.admin
Methods in org.keycloak.services.resources.admin with parameters of type GroupModel Modifier and Type Method Description static ManagementPermissionReference
GroupResource. toMgmtRef(GroupModel group, AdminPermissionManagement permissions)
static void
GroupResource. updateGroup(GroupRepresentation rep, GroupModel model, RealmModel realm, KeycloakSession session)
Constructors in org.keycloak.services.resources.admin with parameters of type GroupModel Constructor Description GroupResource(RealmModel realm, GroupModel group, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
-
Uses of GroupModel in org.keycloak.services.resources.admin.permissions
Methods in org.keycloak.services.resources.admin.permissions with parameters of type GroupModel Modifier and Type Method Description boolean
GroupPermissionEvaluator. canManage(GroupModel group)
boolean
GroupPermissionEvaluator. canManageMembers(GroupModel group)
boolean
GroupPermissionEvaluator. canManageMembership(GroupModel group)
boolean
GroupPermissionEvaluator. canView(GroupModel group)
Map<String,Boolean>
GroupPermissionEvaluator. getAccess(GroupModel group)
boolean
GroupPermissionEvaluator. getGroupsWithViewPermission(GroupModel group)
Map<String,String>
GroupPermissionManagement. getPermissions(GroupModel group)
boolean
GroupPermissionManagement. isPermissionsEnabled(GroupModel group)
Policy
GroupPermissionManagement. manageMembershipPermission(GroupModel group)
Policy
GroupPermissionManagement. manageMembersPermission(GroupModel group)
Policy
GroupPermissionManagement. managePermission(GroupModel group)
void
GroupPermissionEvaluator. requireManage(GroupModel group)
void
GroupPermissionEvaluator. requireManageMembers(GroupModel group)
void
GroupPermissionEvaluator. requireManageMembership(GroupModel group)
void
GroupPermissionEvaluator. requireView(GroupModel group)
void
GroupPermissionEvaluator. requireViewMembers(GroupModel group)
Resource
GroupPermissionManagement. resource(GroupModel group)
void
GroupPermissionManagement. setPermissionsEnabled(GroupModel group, boolean enable)
Policy
GroupPermissionManagement. viewMembersPermission(GroupModel group)
Policy
GroupPermissionManagement. viewPermission(GroupModel group)
-
Uses of GroupModel in org.keycloak.storage
Methods in org.keycloak.storage that return GroupModel Modifier and Type Method Description GroupModel
GroupStorageManager. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel
GroupStorageManager. getGroupById(RealmModel realm, String id)
Methods in org.keycloak.storage that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
GroupStorageManager. getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<GroupModel>
GroupStorageManager. getGroupsStream(RealmModel realm)
Stream<GroupModel>
GroupStorageManager. getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>
GroupStorageManager. getTopLevelGroupsStream(RealmModel realm)
Stream<GroupModel>
GroupStorageManager. getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<GroupModel>
GroupStorageManager. searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
Obtaining groups from an external client storage is time-bounded.Stream<GroupModel>
GroupStorageManager. searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Methods in org.keycloak.storage with parameters of type GroupModel Modifier and Type Method Description void
GroupStorageManager. addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel
GroupStorageManager. createGroup(RealmModel realm, String id, String name, GroupModel toParent)
Stream<UserModel>
UserStorageManager. getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
UserLookupProvider
methods implementations end hereUserQueryProvider
methods implementation start herevoid
GroupStorageManager. moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void
UserStorageManager. preRemove(RealmModel realm, GroupModel group)
default void
UserStorageProvider. preRemove(RealmModel realm, GroupModel group)
Callback when a group is removed.boolean
GroupStorageManager. removeGroup(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.storage.adapter
Methods in org.keycloak.storage.adapter that return types with arguments of type GroupModel Modifier and Type Method Description Set<GroupModel>
AbstractUserAdapter. getGroups()
Deprecated.UseAbstractUserAdapter.getGroupsStream()
insteadSet<GroupModel>
AbstractUserAdapter.Streams. getGroups()
Set<GroupModel>
AbstractUserAdapterFederatedStorage. getGroups()
Deprecated.Set<GroupModel>
AbstractUserAdapterFederatedStorage.Streams. getGroups()
protected Set<GroupModel>
AbstractUserAdapter. getGroupsInternal()
Get group membership mappings that are managed by this storage providerprotected Set<GroupModel>
AbstractUserAdapterFederatedStorage. getGroupsInternal()
Get group membership mappings that are managed by this storage providerStream<GroupModel>
AbstractUserAdapter. getGroupsStream()
Stream<GroupModel>
AbstractUserAdapter.Streams. getGroupsStream()
Stream<GroupModel>
AbstractUserAdapterFederatedStorage. getGroupsStream()
Stream<GroupModel>
AbstractUserAdapterFederatedStorage.Streams. getGroupsStream()
Stream<GroupModel>
InMemoryUserAdapter. getGroupsStream()
Methods in org.keycloak.storage.adapter with parameters of type GroupModel Modifier and Type Method Description boolean
AbstractUserAdapter. isMemberOf(GroupModel group)
boolean
AbstractUserAdapter.Streams. isMemberOf(GroupModel group)
boolean
AbstractUserAdapterFederatedStorage. isMemberOf(GroupModel group)
boolean
AbstractUserAdapterFederatedStorage.Streams. isMemberOf(GroupModel group)
boolean
InMemoryUserAdapter. isMemberOf(GroupModel group)
void
AbstractUserAdapter. joinGroup(GroupModel group)
void
AbstractUserAdapterFederatedStorage. joinGroup(GroupModel group)
void
InMemoryUserAdapter. joinGroup(GroupModel group)
void
UpdateOnlyChangeUserModelDelegate. joinGroup(GroupModel group)
void
AbstractUserAdapter. leaveGroup(GroupModel group)
void
AbstractUserAdapterFederatedStorage. leaveGroup(GroupModel group)
void
InMemoryUserAdapter. leaveGroup(GroupModel group)
void
UpdateOnlyChangeUserModelDelegate. leaveGroup(GroupModel group)
-
Uses of GroupModel in org.keycloak.storage.client
Methods in org.keycloak.storage.client with parameters of type GroupModel Modifier and Type Method Description default void
ClientStorageProvider. preRemove(RealmModel realm, GroupModel group)
Callback when a group is removed. -
Uses of GroupModel in org.keycloak.storage.federated
Methods in org.keycloak.storage.federated that return types with arguments of type GroupModel Modifier and Type Method Description Set<GroupModel>
UserGroupMembershipFederatedStorage. getGroups(RealmModel realm, String userId)
Deprecated.UsegetGroupsStream
instead.default Set<GroupModel>
UserGroupMembershipFederatedStorage.Streams. getGroups(RealmModel realm, String userId)
default Stream<GroupModel>
UserGroupMembershipFederatedStorage. getGroupsStream(RealmModel realm, String userId)
Obtains the groups associated with the federated user.Stream<GroupModel>
UserGroupMembershipFederatedStorage.Streams. getGroupsStream(RealmModel realm, String userId)
Methods in org.keycloak.storage.federated with parameters of type GroupModel Modifier and Type Method Description List<String>
UserGroupMembershipFederatedStorage. getMembership(RealmModel realm, GroupModel group, int firstResult, int max)
Deprecated.UsegetMembershipStream
instead.default List<String>
UserGroupMembershipFederatedStorage.Streams. getMembership(RealmModel realm, GroupModel group, int firstResult, int max)
default Stream<String>
UserGroupMembershipFederatedStorage. getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)
Obtains the federated users that are members of the givengroup
in the specifiedrealm
.Stream<String>
UserGroupMembershipFederatedStorage.Streams. getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)
void
UserGroupMembershipFederatedStorage. joinGroup(RealmModel realm, String userId, GroupModel group)
void
UserGroupMembershipFederatedStorage. leaveGroup(RealmModel realm, String userId, GroupModel group)
void
UserFederatedStorageProvider. preRemove(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.storage.group
Methods in org.keycloak.storage.group that return GroupModel Modifier and Type Method Description GroupModel
GroupLookupProvider. getGroupById(RealmModel realm, String id)
Returns a group from the given realm with the corresponding idMethods in org.keycloak.storage.group that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
GroupLookupProvider. searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
Returns the group hierarchy with the given string in name for the given realm.default Stream<GroupModel>
GroupLookupProvider. searchForGroupByNameStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)
Deprecated.Stream<GroupModel>
GroupLookupProvider. searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Returns the groups filtered by attribute names and attribute values for the given realm. -
Uses of GroupModel in org.keycloak.storage.jpa
Methods in org.keycloak.storage.jpa that return types with arguments of type GroupModel Modifier and Type Method Description Stream<GroupModel>
JpaUserFederatedStorageProvider. getGroupsStream(RealmModel realm, String userId)
Methods in org.keycloak.storage.jpa with parameters of type GroupModel Modifier and Type Method Description Stream<String>
JpaUserFederatedStorageProvider. getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)
void
JpaUserFederatedStorageProvider. joinGroup(RealmModel realm, String userId, GroupModel group)
void
JpaUserFederatedStorageProvider. leaveGroup(RealmModel realm, String userId, GroupModel group)
void
JpaUserFederatedStorageProvider. preRemove(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.storage.ldap
Methods in org.keycloak.storage.ldap with parameters of type GroupModel Modifier and Type Method Description Stream<UserModel>
LDAPStorageProvider. getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
void
LDAPStorageProvider. preRemove(RealmModel realm, GroupModel group)
-
Uses of GroupModel in org.keycloak.storage.ldap.mappers
Methods in org.keycloak.storage.ldap.mappers with parameters of type GroupModel Modifier and Type Method Description List<UserModel>
AbstractLDAPStorageMapper. getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
List<UserModel>
LDAPStorageMapper. getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
Return empty list if doesn't support storing of groups -
Uses of GroupModel in org.keycloak.storage.ldap.mappers.membership.group
Methods in org.keycloak.storage.ldap.mappers.membership.group that return GroupModel Modifier and Type Method Description protected GroupModel
GroupLDAPStorageMapper. createKcGroup(RealmModel realm, String ldapGroupName, GroupModel parentGroup)
Creates a new KC group from given LDAP group name in given KC parent group or the groups path.protected GroupModel
GroupLDAPStorageMapper. findKcGroupByLDAPGroup(RealmModel realm, LDAPObject ldapGroup)
protected GroupModel
GroupLDAPStorageMapper. findKcGroupOrSyncFromLDAP(RealmModel realm, LDAPObject ldapGroup, UserModel user)
protected GroupModel
GroupLDAPStorageMapper. getKcGroupsPathGroup(RealmModel realm)
Provides KC group defined as groups path or null (top-level group) if corresponding group is not available.Methods in org.keycloak.storage.ldap.mappers.membership.group that return types with arguments of type GroupModel Modifier and Type Method Description protected Stream<GroupModel>
GroupLDAPStorageMapper. getAllKcGroups(RealmModel realm)
Provides a stream of all KC groups (with their sub groups) from groups path configured by the "Groups Path" configuration property.Stream<GroupModel>
GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate. getGroupsStream()
protected Stream<GroupModel>
GroupLDAPStorageMapper. getKcSubGroups(RealmModel realm, GroupModel parentGroup)
Provides a list of all KC sub groups from given parent group or from groups path.protected Stream<GroupModel>
GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate. getLDAPGroupMappingsConverted()
Methods in org.keycloak.storage.ldap.mappers.membership.group with parameters of type GroupModel Modifier and Type Method Description void
GroupLDAPStorageMapper. addGroupMappingInLDAP(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser)
protected GroupModel
GroupLDAPStorageMapper. createKcGroup(RealmModel realm, String ldapGroupName, GroupModel parentGroup)
Creates a new KC group from given LDAP group name in given KC parent group or the groups path.List<UserModel>
GroupLDAPStorageMapper. getGroupMembers(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults)
protected Stream<GroupModel>
GroupLDAPStorageMapper. getKcSubGroups(RealmModel realm, GroupModel parentGroup)
Provides a list of all KC sub groups from given parent group or from groups path.boolean
GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate. isMemberOf(GroupModel group)
void
GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate. joinGroup(GroupModel group)
void
GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate. leaveGroup(GroupModel group)
-
Uses of GroupModel in org.keycloak.storage.user
Methods in org.keycloak.storage.user with parameters of type GroupModel Modifier and Type Method Description default Stream<UserModel>
UserQueryProvider. getGroupMembersStream(RealmModel realm, GroupModel group)
Obtains users that belong to a specific group.Stream<UserModel>
UserQueryProvider. getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Obtains users that belong to a specific group.
-