Uses of Interface
org.keycloak.models.RoleModel

Packages that use RoleModel

Package	Description
org.keycloak.models
org.keycloak.models.utils
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.client
org.keycloak.storage.federated
org.keycloak.storage.role
org.keycloak.storage.user

Uses of RoleModel in org.keycloak.models

Fields in org.keycloak.models with type parameters of type RoleModel

Modifier and Type	Field	Description
static SearchableModelField<RoleModel>	RoleModel.SearchableFields.CLIENT_ID	If client role, ID of the client (not the clientId)
static SearchableModelField<RoleModel>	RoleModel.SearchableFields.DESCRIPTION
static SearchableModelField<RoleModel>	RoleModel.SearchableFields.ID
static SearchableModelField<RoleModel>	RoleModel.SearchableFields.IS_CLIENT_ROLE
static SearchableModelField<RoleModel>	RoleModel.SearchableFields.NAME
static SearchableModelField<RoleModel>	RoleModel.SearchableFields.REALM_ID

Methods in org.keycloak.models that return RoleModel

Modifier and Type	Method	Description
default RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String name)	Deprecated. Use the corresponding method from RoleProvider.
default RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String id, String name)	Deprecated. Use the corresponding method from RoleProvider.
default RoleModel	RoleProvider.addClientRole(ClientModel client, String name)	Adds a client role with given name to the given client.
RoleModel	RoleProvider.addClientRole(ClientModel client, String id, String name)	Adds a client role with given internal ID and name to the given client.
default RoleModel	RealmProvider.addRealmRole(RealmModel realm, String name)	Deprecated. Use the corresponding method from RoleProvider.
RoleModel	RealmProvider.addRealmRole(RealmModel realm, String id, String name)	Deprecated. Use the corresponding method from RoleProvider.
default RoleModel	RoleProvider.addRealmRole(RealmModel realm, String name)	Adds a realm role with given name to the given realm.
RoleModel	RoleProvider.addRealmRole(RealmModel realm, String id, String name)	Adds a realm role with given internal ID and name to the given realm.
RoleModel	RoleContainerModel.addRole(String name)
RoleModel	RoleContainerModel.addRole(String id, String name)
default RoleModel	RealmProvider.getClientRole(RealmModel realm, ClientModel client, String name)	Deprecated. Use the corresponding method from RoleProvider.
RoleModel	RealmModel.getDefaultRole()	Returns default realm role.
RoleModel	RealmProvider.getRealmRole(RealmModel realm, String name)	Deprecated. Use the corresponding method from RoleProvider.
RoleModel	RoleContainerModel.getRole(String name)
RoleModel	RoleContainerModel.RoleRemovedEvent.getRole()
RoleModel	RealmModel.getRoleById(String id)
default RoleModel	RealmProvider.getRoleById(String id, RealmModel realm)	Deprecated. Use the corresponding method from RoleProvider.

Methods in org.keycloak.models that return types with arguments of type RoleModel

Modifier and Type	Method	Description
Set<RoleModel>	RoleMapperModel.getClientRoleMappings(ClientModel app)	Deprecated. Use getClientRoleMappingsStream instead.
default Set<RoleModel>	RoleMapperModel.Streams.getClientRoleMappings(ClientModel app)
default Stream<RoleModel>	RoleMapperModel.getClientRoleMappingsStream(ClientModel app)	Returns stream of client roles that are directly set to this object for the given client.
Stream<RoleModel>	RoleMapperModel.Streams.getClientRoleMappingsStream(ClientModel app)
default Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default Stream<RoleModel>	RoleProvider.getClientRolesStream(ClientModel client)	Returns all the client roles of the given client.
Stream<RoleModel>	RoleProvider.getClientRolesStream(ClientModel client, Integer first, Integer max)	Returns the client roles of the given client.
default Set<RoleModel>	RoleModel.getComposites()	Deprecated. Use getCompositesStream instead.
default Stream<RoleModel>	RoleModel.getCompositesStream()	Returns all composite roles as a stream.
Stream<RoleModel>	RoleModel.getCompositesStream(String search, Integer first, Integer max)	Returns a paginated stream of composite roles of this role that contain given string in its name.
Set<RoleModel>	RoleMapperModel.getRealmRoleMappings()	Deprecated. Use getRealmRoleMappingsStream instead.
default Set<RoleModel>	RoleMapperModel.Streams.getRealmRoleMappings()
default Stream<RoleModel>	RoleMapperModel.getRealmRoleMappingsStream()	Returns stream of realm roles that are directly set to this object.
Stream<RoleModel>	RoleMapperModel.Streams.getRealmRoleMappingsStream()
default Set<RoleModel>	RealmProvider.getRealmRoles(RealmModel realm)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.getRealmRoles(RealmModel realm, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RoleProvider.getRealmRoles(RealmModel realm)	Deprecated. use the stream variant instead
default Stream<RoleModel>	RoleProvider.getRealmRolesStream(RealmModel realm)	Returns all the realm roles of the given realm as a stream.
Stream<RoleModel>	RoleProvider.getRealmRolesStream(RealmModel realm, Integer first, Integer max)	Returns the realm roles of the given realm as a stream.
default Set<RoleModel>	ScopeContainerModel.getRealmScopeMappings()	Deprecated. Use getRealmScopeMappingsStream instead.
Stream<RoleModel>	ScopeContainerModel.getRealmScopeMappingsStream()	From the scope mappings returned by ScopeContainerModel.getScopeMappingsStream() returns only those that belong to the realm that owns this scope container.
Set<RoleModel>	RoleMapperModel.getRoleMappings()	Deprecated. Use getRoleMappingsStream instead.
default Set<RoleModel>	RoleMapperModel.Streams.getRoleMappings()
default Stream<RoleModel>	RoleMapperModel.getRoleMappingsStream()	Returns stream of all role (both realm all client) that are directly set to this object.
Stream<RoleModel>	RoleMapperModel.Streams.getRoleMappingsStream()
default Set<RoleModel>	ClientSessionContext.getRoles()	Deprecated. Use getRolesStream instead.
default Set<RoleModel>	RoleContainerModel.getRoles()	Deprecated. Use getRolesStream instead.
default Set<RoleModel>	RoleContainerModel.getRoles(Integer firstResult, Integer maxResults)	Deprecated. Use getRolesStream instead.
Stream<RoleModel>	ClientSessionContext.getRolesStream()	Returns all roles including composite ones as a stream.
Stream<RoleModel>	RoleContainerModel.getRolesStream()	Returns available roles as a stream.
Stream<RoleModel>	RoleContainerModel.getRolesStream(Integer firstResult, Integer maxResults)	Returns available roles as a stream.
Stream<RoleModel>	RoleProvider.getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)	Returns a paginated stream of roles with given ids and given search value in role names.
default Set<RoleModel>	ScopeContainerModel.getScopeMappings()	Deprecated. Use getScopeMappingsStream instead.
Stream<RoleModel>	ScopeContainerModel.getScopeMappingsStream()	Returns scope mappings for this scope container as a stream.
default Set<RoleModel>	RealmProvider.searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.searchForRoles(RealmModel realm, String search, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RoleContainerModel.searchForRoles(String search, Integer first, Integer max)	Deprecated. Use searchForRolesStream instead.
Stream<RoleModel>	RoleContainerModel.searchForRolesStream(String search, Integer first, Integer max)	Searches roles by the given name.

Methods in org.keycloak.models with parameters of type RoleModel

Modifier and Type	Method	Description
void	RoleModel.addCompositeRole(RoleModel role)
void	ScopeContainerModel.addScopeMapping(RoleModel role)
default void	RealmModel.addToDefaultRoles(RoleModel role)	Adds a role as a composite to default role of this realm.
void	RoleMapperModel.deleteRoleMapping(RoleModel role)	Removes the given role mapping from this object.
void	ScopeContainerModel.deleteScopeMapping(RoleModel role)
default List<GroupModel>	GroupProvider.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)	Deprecated. Use getGroupsByRoleStream instead.
default List<GroupModel>	RealmProvider.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)	Deprecated. Use the corresponding method from GroupProvider.
Stream<GroupModel>	GroupProvider.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)	Returns groups with the given role in the given realm.
void	RoleMapperModel.grantRole(RoleModel role)	Grants the given role to this object.
default boolean	RoleMapperModel.hasDirectRole(RoleModel role)	Returns true, if this object is directly assigned the given role.
default boolean	ClientModel.hasDirectScope(RoleModel role)
default boolean	ScopeContainerModel.hasDirectScope(RoleModel role)	Returns true, if this object has the given role directly in its scope.
boolean	RoleMapperModel.hasRole(RoleModel role)	Returns true if this object is directly or indirectly assigned the given role, false otherwise.
boolean	RoleModel.hasRole(RoleModel role)
boolean	ScopeContainerModel.hasScope(RoleModel role)	Returns true, if this object has the given role directly or indirectly in its scope, false otherwise.
void	UserProvider.preRemove(RealmModel realm, RoleModel role)	Called when a role is removed.
void	RoleModel.removeCompositeRole(RoleModel role)
default boolean	RealmProvider.removeRole(RealmModel realm, RoleModel role)	Deprecated. Use the corresponding method from RoleProvider.
boolean	RoleContainerModel.removeRole(RoleModel role)
boolean	RoleProvider.removeRole(RoleModel role)	Removes given realm role from the given realm.
void	RealmModel.setDefaultRole(RoleModel role)	Sets default role for this realm

Uses of RoleModel in org.keycloak.models.utils

Methods in org.keycloak.models.utils that return types with arguments of type RoleModel

Modifier and Type	Method	Description
static Set<RoleModel>	RoleUtils.expandCompositeRoles(Set<RoleModel> roles)
static Stream<RoleModel>	RoleUtils.expandCompositeRolesStream(Stream<RoleModel> roles)
Stream<RoleModel>	UserModelDelegate.getClientRoleMappingsStream(ClientModel app)
static Set<RoleModel>	RoleUtils.getDeepUserRoleMappings(UserModel user)
Stream<RoleModel>	UserModelDelegate.getRealmRoleMappingsStream()
Stream<RoleModel>	UserModelDelegate.getRoleMappingsStream()

Methods in org.keycloak.models.utils with parameters of type RoleModel

Modifier and Type	Method	Description
void	UserModelDelegate.deleteRoleMapping(RoleModel role)
void	UserModelDelegate.grantRole(RoleModel role)
static boolean	RoleUtils.hasRole(Set<RoleModel> roles, RoleModel targetRole)
static boolean	RoleUtils.hasRole(Stream<RoleModel> roles, RoleModel targetRole)
boolean	UserModelDelegate.hasRole(RoleModel role)
static boolean	RoleUtils.hasRoleFromGroup(Iterable<GroupModel> groups, RoleModel targetRole, boolean checkParentGroup)	Deprecated. Use RoleUtils.hasRoleFromGroup(Stream, RoleModel, boolean) hasRoleFromGroup(Stream, RoleModel, boolean)} instead.
static boolean	RoleUtils.hasRoleFromGroup(Stream<GroupModel> groups, RoleModel targetRole, boolean checkParentGroup)	Checks whether the targetRole is contained in any of the groups or their parents (if requested)
static boolean	RoleUtils.hasRoleFromGroup(GroupModel group, RoleModel targetRole, boolean checkParentGroup)	Checks whether the targetRole is contained in the given group or its parents (if requested)
static boolean	RoleUtils.isClientRole(RoleModel r, ClientModel c)
static boolean	RoleUtils.isRealmRole(RoleModel r)
static boolean	RoleUtils.isRealmRole(RoleModel r, RealmModel realm)

Method parameters in org.keycloak.models.utils with type arguments of type RoleModel

Modifier and Type	Method	Description
static Set<RoleModel>	RoleUtils.expandCompositeRoles(Set<RoleModel> roles)
static Stream<RoleModel>	RoleUtils.expandCompositeRolesStream(Stream<RoleModel> roles)
static boolean	RoleUtils.hasRole(Set<RoleModel> roles, RoleModel targetRole)
static boolean	RoleUtils.hasRole(Stream<RoleModel> roles, RoleModel targetRole)

Uses of RoleModel in org.keycloak.storage

Methods in org.keycloak.storage with parameters of type RoleModel

Modifier and Type	Method	Description
default void	UserStorageProvider.preRemove(RealmModel realm, RoleModel role)	Callback when a role is removed.

Uses of RoleModel in org.keycloak.storage.adapter

Methods in org.keycloak.storage.adapter that return types with arguments of type RoleModel

Modifier and Type	Method	Description
Set<RoleModel>	AbstractUserAdapter.getClientRoleMappings(ClientModel app)
Set<RoleModel>	AbstractUserAdapter.Streams.getClientRoleMappings(ClientModel app)
Set<RoleModel>	AbstractUserAdapterFederatedStorage.getClientRoleMappings(ClientModel app)	Gets role mappings from federated storage and automatically appends default roles.
Set<RoleModel>	AbstractUserAdapterFederatedStorage.Streams.getClientRoleMappings(ClientModel app)
Stream<RoleModel>	AbstractUserAdapter.Streams.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	AbstractUserAdapterFederatedStorage.Streams.getClientRoleMappingsStream(ClientModel app)
protected Set<RoleModel>	AbstractUserAdapterFederatedStorage.getFederatedRoleMappings()
Set<RoleModel>	AbstractUserAdapter.getRealmRoleMappings()
Set<RoleModel>	AbstractUserAdapter.Streams.getRealmRoleMappings()
Set<RoleModel>	AbstractUserAdapterFederatedStorage.getRealmRoleMappings()	Gets role mappings from federated storage and automatically appends default roles.
Set<RoleModel>	AbstractUserAdapterFederatedStorage.Streams.getRealmRoleMappings()
Stream<RoleModel>	AbstractUserAdapter.Streams.getRealmRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapterFederatedStorage.Streams.getRealmRoleMappingsStream()
Set<RoleModel>	AbstractUserAdapter.getRoleMappings()
Set<RoleModel>	AbstractUserAdapter.Streams.getRoleMappings()
Set<RoleModel>	AbstractUserAdapterFederatedStorage.getRoleMappings()	Gets role mappings from federated storage and automatically appends default roles.
Set<RoleModel>	AbstractUserAdapterFederatedStorage.Streams.getRoleMappings()
protected Set<RoleModel>	AbstractUserAdapter.getRoleMappingsInternal()
protected Set<RoleModel>	AbstractUserAdapterFederatedStorage.getRoleMappingsInternal()
Stream<RoleModel>	AbstractUserAdapter.Streams.getRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapterFederatedStorage.Streams.getRoleMappingsStream()

Methods in org.keycloak.storage.adapter with parameters of type RoleModel

Modifier and Type	Method	Description
void	AbstractUserAdapter.deleteRoleMapping(RoleModel role)
void	AbstractUserAdapterFederatedStorage.deleteRoleMapping(RoleModel role)
void	AbstractUserAdapter.grantRole(RoleModel role)
void	AbstractUserAdapterFederatedStorage.grantRole(RoleModel role)
boolean	AbstractUserAdapter.hasRole(RoleModel role)
boolean	AbstractUserAdapter.Streams.hasRole(RoleModel role)
boolean	AbstractUserAdapterFederatedStorage.hasRole(RoleModel role)
boolean	AbstractUserAdapterFederatedStorage.Streams.hasRole(RoleModel role)

Uses of RoleModel in org.keycloak.storage.client

Methods in org.keycloak.storage.client with parameters of type RoleModel

Modifier and Type	Method	Description
default void	ClientStorageProvider.preRemove(RealmModel realm, RoleModel role)	Callback when a role is removed.

Uses of RoleModel in org.keycloak.storage.federated

Methods in org.keycloak.storage.federated that return types with arguments of type RoleModel

Modifier and Type	Method	Description
Set<RoleModel>	UserRoleMappingsFederatedStorage.getRoleMappings(RealmModel realm, String userId)	Deprecated. Use getRoleMappingsStream instead.
default Set<RoleModel>	UserRoleMappingsFederatedStorage.Streams.getRoleMappings(RealmModel realm, String userId)
default Stream<RoleModel>	UserRoleMappingsFederatedStorage.getRoleMappingsStream(RealmModel realm, String userId)	Obtains the roles associated with the federated user identified by userId.
Stream<RoleModel>	UserRoleMappingsFederatedStorage.Streams.getRoleMappingsStream(RealmModel realm, String userId)

Methods in org.keycloak.storage.federated with parameters of type RoleModel

Modifier and Type	Method	Description
void	UserRoleMappingsFederatedStorage.deleteRoleMapping(RealmModel realm, String userId, RoleModel role)
void	UserRoleMappingsFederatedStorage.grantRole(RealmModel realm, String userId, RoleModel role)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, RoleModel role)

Uses of RoleModel in org.keycloak.storage.role

Methods in org.keycloak.storage.role that return RoleModel

Modifier and Type	Method	Description
RoleModel	RoleLookupProvider.getClientRole(ClientModel client, String name)	Exact search for a client role by given name.
RoleModel	RoleLookupProvider.getRealmRole(RealmModel realm, String name)	Exact search for a role by given name.
RoleModel	RoleLookupProvider.getRoleById(RealmModel realm, String id)	Exact search for a role by its internal ID..

Methods in org.keycloak.storage.role that return types with arguments of type RoleModel

Modifier and Type	Method	Description
Stream<RoleModel>	RoleLookupProvider.searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)	Case-insensitive search for client roles that contain the given string in their name or description.
Stream<RoleModel>	RoleLookupProvider.searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)	Case-insensitive search for roles that contain the given string in their name or description.

Uses of RoleModel in org.keycloak.storage.user

Methods in org.keycloak.storage.user with parameters of type RoleModel

Modifier and Type	Method	Description
default List<UserModel>	UserQueryProvider.getRoleMembers(RealmModel realm, RoleModel role)	Deprecated. Use getRoleMembersStream instead.
default List<UserModel>	UserQueryProvider.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)	Deprecated. Use getRoleMembersStream instead.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role)	Obtains users that have the specified role.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)	Searches for users that have the specified role.
void	UserBulkUpdateProvider.grantToAllUsers(RealmModel realm, RoleModel role)	Grants the given role to all users from particular realm.