Uses of Interface
org.keycloak.models.RoleModel

Packages that use RoleModel

Package	Description
org.keycloak.exportimport.util
org.keycloak.federation.kerberos
org.keycloak.federation.sssd
org.keycloak.models
org.keycloak.models.cache.infinispan
org.keycloak.models.cache.infinispan.entities
org.keycloak.models.delegate
org.keycloak.models.jpa
org.keycloak.models.light
org.keycloak.models.oid4vci
org.keycloak.models.utils
org.keycloak.partialimport
org.keycloak.protocol.oidc
org.keycloak.protocol.saml.mappers
org.keycloak.services.resources.admin
org.keycloak.services.resources.admin.fgap
org.keycloak.services.util
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.client
org.keycloak.storage.federated
org.keycloak.storage.jpa
org.keycloak.storage.ldap
org.keycloak.storage.ldap.mappers
org.keycloak.storage.ldap.mappers.membership.group
org.keycloak.storage.ldap.mappers.membership.role
org.keycloak.storage.role
org.keycloak.storage.user

Uses of RoleModel in org.keycloak.exportimport.util

Methods in org.keycloak.exportimport.util with parameters of type RoleModel

Modifier and Type	Method	Description
static RoleRepresentation	ExportUtils.exportRole(RoleModel role)	Full export of role including composite roles

Method parameters in org.keycloak.exportimport.util with type arguments of type RoleModel

Modifier and Type	Method	Description
static List<RoleRepresentation>	ExportUtils.exportRoles(Stream<RoleModel> roles)

Uses of RoleModel in org.keycloak.federation.kerberos

Methods in org.keycloak.federation.kerberos with parameters of type RoleModel

Modifier and Type	Method	Description
void	KerberosFederationProvider.preRemove(RealmModel realm, RoleModel role)

Uses of RoleModel in org.keycloak.federation.sssd

Methods in org.keycloak.federation.sssd with parameters of type RoleModel

Modifier and Type	Method	Description
void	SSSDFederationProvider.preRemove(RealmModel realm, RoleModel role)

Uses of RoleModel in org.keycloak.models

Methods in org.keycloak.models that return RoleModel

Modifier and Type	Method	Description
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	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)
RoleModel	RealmModel.getDefaultRole()	Returns default realm role.
RoleModel	RoleContainerModel.getRole(String name)
RoleModel	RoleContainerModel.RoleRemovedEvent.getRole()
RoleModel	RoleModel.RoleEvent.getRole()
RoleModel	RealmModel.getRoleById(String id)

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

Modifier and Type	Method	Description
Stream<RoleModel>	RoleMapperModel.getClientRoleMappingsStream(ClientModel app)	Returns stream of client roles that are directly set to this object for the given client.
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 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.
Stream<RoleModel>	RoleMapperModel.getRealmRoleMappingsStream()	Returns stream of realm roles that are directly set to this object.
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.
Stream<RoleModel>	ClientScopeDecorator.getRealmScopeMappingsStream()
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.
Stream<RoleModel>	RoleMapperModel.getRoleMappingsStream()	Returns stream of all role (both realm all client) that are directly set to this object.
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.
Stream<RoleModel>	ClientScopeDecorator.getScopeMappingsStream()
Stream<RoleModel>	ScopeContainerModel.getScopeMappingsStream()	Returns scope mappings for this scope container as a stream.
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	ClientScopeDecorator.addScopeMapping(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	ClientScopeDecorator.deleteScopeMapping(RoleModel role)
void	ScopeContainerModel.deleteScopeMapping(RoleModel role)
static void	RoleModel.RoleGrantedEvent.fire(RoleModel role, UserModel user, KeycloakSession session)
static void	RoleModel.RoleRevokedEvent.fire(RoleModel role, UserModel user, KeycloakSession session)
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)
boolean	ClientScopeDecorator.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	ClientScopeDecorator.hasScope(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)
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.cache.infinispan

Classes in org.keycloak.models.cache.infinispan that implement RoleModel

Modifier and Type	Class	Description
class	RoleAdapter

Fields in org.keycloak.models.cache.infinispan declared as RoleModel

Modifier and Type	Field	Description
protected RoleModel	RoleAdapter.updated

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

Modifier and Type	Field	Description
protected Set<RoleModel>	RoleAdapter.composites

Methods in org.keycloak.models.cache.infinispan that return RoleModel

Modifier and Type	Method	Description
RoleModel	RealmCacheSession.addClientRole(ClientModel client, String name)
RoleModel	RealmCacheSession.addClientRole(ClientModel client, String id, String name)
RoleModel	RealmCacheSession.addRealmRole(RealmModel realm, String name)
RoleModel	RealmCacheSession.addRealmRole(RealmModel realm, String id, String name)
RoleModel	ClientAdapter.addRole(String name)
RoleModel	ClientAdapter.addRole(String id, String name)
RoleModel	RealmAdapter.addRole(String name)
RoleModel	RealmAdapter.addRole(String id, String name)
RoleModel	RealmCacheSession.getClientRole(ClientModel client, String name)
RoleModel	RealmAdapter.getDefaultRole()
RoleModel	RealmCacheSession.getRealmRole(RealmModel realm, String name)
RoleModel	ClientAdapter.getRole(String name)
RoleModel	RealmAdapter.getRole(String name)
RoleModel	RealmAdapter.getRoleById(String id)
RoleModel	RealmCacheSession.getRoleById(RealmModel realm, String id)

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

Modifier and Type	Method	Description
Stream<RoleModel>	GroupAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	UserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	RealmCacheSession.getClientRolesStream(ClientModel client)
Stream<RoleModel>	RealmCacheSession.getClientRolesStream(ClientModel client, Integer first, Integer max)
Stream<RoleModel>	RoleAdapter.getCompositesStream()
Stream<RoleModel>	RoleAdapter.getCompositesStream(String search, Integer first, Integer max)
Stream<RoleModel>	GroupAdapter.getRealmRoleMappingsStream()
Stream<RoleModel>	UserAdapter.getRealmRoleMappingsStream()
Stream<RoleModel>	RealmCacheSession.getRealmRolesStream(RealmModel realm)
Stream<RoleModel>	RealmCacheSession.getRealmRolesStream(RealmModel realm, Integer first, Integer max)
Stream<RoleModel>	ClientAdapter.getRealmScopeMappingsStream()
Stream<RoleModel>	ClientScopeAdapter.getRealmScopeMappingsStream()
Stream<RoleModel>	GroupAdapter.getRoleMappingsStream()
Stream<RoleModel>	UserAdapter.getRoleMappingsStream()
Stream<RoleModel>	ClientAdapter.getRolesStream()
Stream<RoleModel>	ClientAdapter.getRolesStream(Integer first, Integer max)
Stream<RoleModel>	RealmAdapter.getRolesStream()
Stream<RoleModel>	RealmAdapter.getRolesStream(Integer first, Integer max)
Stream<RoleModel>	RealmCacheSession.getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<RoleModel>	ClientAdapter.getScopeMappingsStream()
Stream<RoleModel>	ClientScopeAdapter.getScopeMappingsStream()
Stream<RoleModel>	RealmCacheSession.searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)
Stream<RoleModel>	RealmCacheSession.searchForClientRolesStream(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max)
Stream<RoleModel>	RealmCacheSession.searchForClientRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<RoleModel>	ClientAdapter.searchForRolesStream(String search, Integer first, Integer max)
Stream<RoleModel>	RealmAdapter.searchForRolesStream(String search, Integer first, Integer max)
Stream<RoleModel>	RealmCacheSession.searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)

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

Modifier and Type	Method	Description
void	RoleAdapter.addCompositeRole(RoleModel role)
void	ClientAdapter.addScopeMapping(RoleModel role)
void	ClientScopeAdapter.addScopeMapping(RoleModel role)
void	RealmAdapter.addToDefaultRoles(RoleModel role)
void	GroupAdapter.deleteRoleMapping(RoleModel role)
void	UserAdapter.deleteRoleMapping(RoleModel role)
void	ClientAdapter.deleteScopeMapping(RoleModel role)
void	ClientScopeAdapter.deleteScopeMapping(RoleModel role)
Stream<GroupModel>	RealmCacheSession.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserCacheSession.getRoleMembersStream(RealmModel realm, RoleModel role)
Stream<UserModel>	UserCacheSession.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
void	GroupAdapter.grantRole(RoleModel role)
void	UserAdapter.grantRole(RoleModel role)
void	UserCacheSession.grantToAllUsers(RealmModel realm, RoleModel role)
boolean	GroupAdapter.hasDirectRole(RoleModel role)
boolean	UserAdapter.hasDirectRole(RoleModel role)
boolean	ClientAdapter.hasDirectScope(RoleModel role)
boolean	ClientScopeAdapter.hasDirectScope(RoleModel role)
boolean	GroupAdapter.hasRole(RoleModel role)
boolean	RoleAdapter.hasRole(RoleModel role)
boolean	UserAdapter.hasRole(RoleModel role)
boolean	ClientAdapter.hasScope(RoleModel role)
boolean	ClientScopeAdapter.hasScope(RoleModel role)
void	UserCacheSession.preRemove(RealmModel realm, RoleModel role)
void	RoleAdapter.removeCompositeRole(RoleModel role)
boolean	ClientAdapter.removeRole(RoleModel role)
boolean	RealmAdapter.removeRole(RoleModel role)
boolean	RealmCacheSession.removeRole(RoleModel role)
void	RealmAdapter.setDefaultRole(RoleModel role)

Uses of RoleModel in org.keycloak.models.cache.infinispan.entities

Method parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type RoleModel

Modifier and Type	Method	Description
MultivaluedHashMap<String,String>	CachedRole.getAttributes(KeycloakSession session, Supplier<RoleModel> roleModel)

Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type RoleModel

Modifier	Constructor	Description
	CachedClientRole(Long revision, String clientId, RoleModel model, RealmModel realm)
	CachedRealmRole(Long revision, RoleModel model, RealmModel realm)
	CachedRole(Long revision, RoleModel model, RealmModel realm)

Uses of RoleModel in org.keycloak.models.delegate

Methods in org.keycloak.models.delegate that return RoleModel

Modifier and Type	Method	Description
RoleModel	ClientModelLazyDelegate.addRole(String name)
RoleModel	ClientModelLazyDelegate.addRole(String id, String name)
RoleModel	ClientModelLazyDelegate.getRole(String name)

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

Modifier and Type	Method	Description
Stream<RoleModel>	ClientModelLazyDelegate.getRealmScopeMappingsStream()
Stream<RoleModel>	ClientModelLazyDelegate.getRolesStream()
Stream<RoleModel>	ClientModelLazyDelegate.getRolesStream(Integer firstResult, Integer maxResults)
Stream<RoleModel>	ClientModelLazyDelegate.getScopeMappingsStream()
Stream<RoleModel>	ClientModelLazyDelegate.searchForRolesStream(String search, Integer first, Integer max)

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

Modifier and Type	Method	Description
void	ClientModelLazyDelegate.addScopeMapping(RoleModel role)
void	ClientModelLazyDelegate.deleteScopeMapping(RoleModel role)
boolean	ClientModelLazyDelegate.hasDirectScope(RoleModel role)
boolean	ClientModelLazyDelegate.hasScope(RoleModel role)
boolean	ClientModelLazyDelegate.removeRole(RoleModel role)

Uses of RoleModel in org.keycloak.models.jpa

Classes in org.keycloak.models.jpa that implement RoleModel

Modifier and Type	Class	Description
class	RoleAdapter

Methods in org.keycloak.models.jpa that return RoleModel

Modifier and Type	Method	Description
RoleModel	JpaRealmProvider.addClientRole(ClientModel client, String name)
RoleModel	JpaRealmProvider.addClientRole(ClientModel client, String id, String name)
RoleModel	JpaRealmProvider.addRealmRole(RealmModel realm, String name)
RoleModel	JpaRealmProvider.addRealmRole(RealmModel realm, String id, String name)
RoleModel	ClientAdapter.addRole(String name)
RoleModel	ClientAdapter.addRole(String id, String name)
RoleModel	RealmAdapter.addRole(String name)
RoleModel	RealmAdapter.addRole(String id, String name)
RoleModel	JpaRealmProvider.getClientRole(ClientModel client, String name)
RoleModel	RealmAdapter.getDefaultRole()
RoleModel	JpaRealmProvider.getRealmRole(RealmModel realm, String name)
RoleModel	ClientAdapter.getRole(String name)
RoleModel	RealmAdapter.getRole(String name)
RoleModel	JpaRealmProvider.getRoleById(RealmModel realm, String id)
RoleModel	RealmAdapter.getRoleById(String id)

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

Modifier and Type	Method	Description
Stream<RoleModel>	GroupAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	UserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	JpaRealmProvider.getClientRolesStream(ClientModel client, Integer first, Integer max)
Stream<RoleModel>	RoleAdapter.getCompositesStream()
Stream<RoleModel>	RoleAdapter.getCompositesStream(String search, Integer first, Integer max)
Stream<RoleModel>	GroupAdapter.getRealmRoleMappingsStream()
Stream<RoleModel>	UserAdapter.getRealmRoleMappingsStream()
Stream<RoleModel>	JpaRealmProvider.getRealmRolesStream(RealmModel realm)
Stream<RoleModel>	JpaRealmProvider.getRealmRolesStream(RealmModel realm, Integer first, Integer max)
Stream<RoleModel>	ClientAdapter.getRealmScopeMappingsStream()
Stream<RoleModel>	ClientScopeAdapter.getRealmScopeMappingsStream()
Stream<RoleModel>	GroupAdapter.getRoleMappingsStream()
Stream<RoleModel>	UserAdapter.getRoleMappingsStream()
Stream<RoleModel>	ClientAdapter.getRolesStream()
Stream<RoleModel>	ClientAdapter.getRolesStream(Integer first, Integer max)
protected Stream<RoleModel>	JpaRealmProvider.getRolesStream(jakarta.persistence.TypedQuery<RoleEntity> query, RealmModel realm, Integer first, Integer max)
Stream<RoleModel>	JpaRealmProvider.getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<RoleModel>	RealmAdapter.getRolesStream()
Stream<RoleModel>	RealmAdapter.getRolesStream(Integer first, Integer max)
Stream<RoleModel>	ClientAdapter.getScopeMappingsStream()
Stream<RoleModel>	ClientScopeAdapter.getScopeMappingsStream()
Stream<RoleModel>	JpaRealmProvider.searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)
Stream<RoleModel>	JpaRealmProvider.searchForClientRolesStream(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max)
Stream<RoleModel>	JpaRealmProvider.searchForClientRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
protected Stream<RoleModel>	JpaRealmProvider.searchForRoles(jakarta.persistence.TypedQuery<RoleEntity> query, RealmModel realm, String search, Integer first, Integer max)
Stream<RoleModel>	ClientAdapter.searchForRolesStream(String search, Integer first, Integer max)
Stream<RoleModel>	JpaRealmProvider.searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)
Stream<RoleModel>	RealmAdapter.searchForRolesStream(String search, Integer first, Integer max)

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

Modifier and Type	Method	Description
void	RoleAdapter.addCompositeRole(RoleModel role)
void	ClientAdapter.addScopeMapping(RoleModel role)
void	ClientScopeAdapter.addScopeMapping(RoleModel role)
void	GroupAdapter.deleteRoleMapping(RoleModel role)
void	UserAdapter.deleteRoleMapping(RoleModel role)
void	ClientAdapter.deleteScopeMapping(RoleModel role)
void	ClientScopeAdapter.deleteScopeMapping(RoleModel role)
protected jakarta.persistence.TypedQuery<GroupRoleMappingEntity>	GroupAdapter.getGroupRoleMappingEntityTypedQuery(RoleModel role)
Stream<GroupModel>	JpaRealmProvider.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	JpaUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role)
Stream<UserModel>	JpaUserProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
protected jakarta.persistence.TypedQuery<UserRoleMappingEntity>	UserAdapter.getUserRoleMappingEntityTypedQuery(RoleModel role)
void	GroupAdapter.grantRole(RoleModel role)
void	UserAdapter.grantRole(RoleModel role)
void	UserAdapter.grantRoleImpl(RoleModel role)
void	JpaUserProvider.grantToAllUsers(RealmModel realm, RoleModel role)
boolean	GroupAdapter.hasRole(RoleModel role)
boolean	RoleAdapter.hasRole(RoleModel role)
boolean	UserAdapter.hasRole(RoleModel role)
boolean	ClientAdapter.hasScope(RoleModel role)
boolean	ClientScopeAdapter.hasScope(RoleModel role)
void	JpaRealmProvider.preRemove(RealmModel realm, RoleModel role)
void	JpaUserProvider.preRemove(RealmModel realm, RoleModel role)
void	RoleAdapter.removeCompositeRole(RoleModel role)
boolean	ClientAdapter.removeRole(RoleModel roleModel)
boolean	JpaRealmProvider.removeRole(RoleModel role)
boolean	RealmAdapter.removeRole(RoleModel role)
RoleContainerModel.RoleRemovedEvent	JpaRealmProvider.roleRemovedEvent(RoleModel role)
void	RealmAdapter.setDefaultRole(RoleModel role)

Uses of RoleModel in org.keycloak.models.light

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

Modifier and Type	Method	Description
void	LightweightUserAdapter.deleteRoleMapping(RoleModel role)
void	LightweightUserAdapter.grantRole(RoleModel role)

Uses of RoleModel in org.keycloak.models.oid4vci

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

Modifier and Type	Method	Description
Stream<RoleModel>	CredentialScopeModel.getRealmScopeMappingsStream()
Stream<RoleModel>	CredentialScopeModel.getScopeMappingsStream()

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

Modifier and Type	Method	Description
void	CredentialScopeModel.addScopeMapping(RoleModel role)
void	CredentialScopeModel.deleteScopeMapping(RoleModel role)
boolean	CredentialScopeModel.hasDirectScope(RoleModel role)
boolean	CredentialScopeModel.hasScope(RoleModel role)

Uses of RoleModel in org.keycloak.models.utils

Methods in org.keycloak.models.utils that return RoleModel

Modifier and Type	Method	Description
RoleModel	RealmModelDelegate.addRole(String name)
RoleModel	RealmModelDelegate.addRole(String id, String name)
static RoleModel	RepresentationToModel.createRole(RealmModel newRealm, RoleRepresentation roleRep)
RoleModel	RealmModelDelegate.getDefaultRole()
RoleModel	RealmModelDelegate.getRole(String name)
RoleModel	RealmModelDelegate.getRoleById(String id)
static RoleModel	KeycloakModelUtils.getRoleFromString(RealmModel realm, String roleName)
static RoleModel	KeycloakModelUtils.setupOfflineRole(RealmModel realm)

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 Stream<RoleModel>	KeycloakModelUtils.getClientScopeMappingsStream(ClientModel client, ScopeContainerModel container)
static Set<RoleModel>	RoleUtils.getDeepUserRoleMappings(UserModel user)
Stream<RoleModel>	UserModelDelegate.getRealmRoleMappingsStream()
Stream<RoleModel>	UserModelDelegate.getRoleMappingsStream()
Stream<RoleModel>	RealmModelDelegate.getRolesStream()
Stream<RoleModel>	RealmModelDelegate.getRolesStream(Integer firstResult, Integer maxResults)
Stream<RoleModel>	RealmModelDelegate.searchForRolesStream(String search, Integer first, Integer max)

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

Modifier and Type	Method	Description
void	RealmModelDelegate.addToDefaultRoles(RoleModel role)
static void	DefaultClientScopes.createOfflineAccessClientScope(RealmModel newRealm, RoleModel offlineRole)
void	ReadOnlyUserModelDelegate.deleteRoleMapping(RoleModel role)
void	UserModelDelegate.deleteRoleMapping(RoleModel role)
void	ReadOnlyUserModelDelegate.grantRole(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(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)
boolean	RealmModelDelegate.removeRole(RoleModel role)
static boolean	KeycloakModelUtils.searchFor(RoleModel role, RoleModel composite, Set<String> visited)	Deep search if given role is descendant of composite role
void	RealmModelDelegate.setDefaultRole(RoleModel role)
static RoleRepresentation	ModelToRepresentation.toBriefRepresentation(RoleModel role)
static RoleRepresentation	ModelToRepresentation.toRepresentation(RoleModel role)

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.partialimport

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

Modifier and Type	Method	Description
protected void	RealmRolesPartialImport.RoleHelper.deleteRole(RoleModel role)

Uses of RoleModel in org.keycloak.protocol.oidc

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

Modifier and Type	Method	Description
static Set<RoleModel>	TokenManager.getAccess(UserModel user, ClientModel client, Stream<ClientScopeModel> clientScopes)

Uses of RoleModel in org.keycloak.protocol.saml.mappers

Methods in org.keycloak.protocol.saml.mappers with parameters of type RoleModel

Modifier and Type	Method	Description
String	RoleNameMapper.mapName(ProtocolMapperModel model, RoleModel roleModel)
String	SAMLRoleNameMapper.mapName(ProtocolMapperModel model, RoleModel role)

Uses of RoleModel in org.keycloak.services.resources.admin

Methods in org.keycloak.services.resources.admin that return RoleModel

Modifier and Type	Method	Description
protected RoleModel	RoleByIdResource.getRoleModel(String id)

Methods in org.keycloak.services.resources.admin with parameters of type RoleModel

Modifier and Type	Method	Description
protected void	RoleResource.addComposites(AdminPermissionEvaluator auth, AdminEventBuilder adminEvent, jakarta.ws.rs.core.UriInfo uriInfo, List<RoleRepresentation> roles, RoleModel role)
protected void	RoleResource.deleteComposites(AdminEventBuilder adminEvent, jakarta.ws.rs.core.UriInfo uriInfo, List<RoleRepresentation> roles, RoleModel role)
protected void	RoleResource.deleteRole(RoleModel role)
protected Stream<RoleRepresentation>	RoleResource.getClientRoleComposites(ClientModel app, RoleModel role)
protected Stream<RoleRepresentation>	RoleResource.getRealmRoleComposites(RoleModel role)
protected RoleRepresentation	RoleResource.getRole(RoleModel roleModel)
static ManagementPermissionReference	RoleByIdResource.toMgmtRef(RoleModel role, AdminPermissionManagement permissions)
protected void	RoleResource.updateRole(RoleRepresentation rep, RoleModel role, RealmModel realm, KeycloakSession session)

Uses of RoleModel in org.keycloak.services.resources.admin.fgap

Methods in org.keycloak.services.resources.admin.fgap with parameters of type RoleModel

Modifier and Type	Method	Description
boolean	RolePermissionEvaluator.canManage(RoleModel role)	If the role is a realm role, it returns true if RealmPermissionEvaluator.canManageRealm() returns true.
boolean	RolePermissionEvaluator.canMapClientScope(RoleModel role)	Returns true if ClientPermissions.canManageClientsDefault() returns true.
boolean	RolePermissionEvaluator.canMapComposite(RoleModel role)	Returns true if RolePermissions.canManageDefault(RoleModel) and RolePermissions.checkAdminRoles(RoleModel) returns true.
boolean	RolePermissionEvaluator.canMapRole(RoleModel role)	Returns true if the caller has AdminRoles.MANAGE_USERS role and RolePermissions.checkAdminRoles(RoleModel) returns true.
boolean	RolePermissionEvaluator.canView(RoleModel role)	If the role is a realm role, it returns true if RealmPermissionEvaluator.canViewRealm() returns true.
Map<String,String>	RolePermissionManagement.getPermissions(RoleModel role)
boolean	RolePermissionManagement.isPermissionsEnabled(RoleModel role)
Policy	RolePermissionManagement.mapClientScopePermission(RoleModel role)
Policy	RolePermissionManagement.mapCompositePermission(RoleModel role)
Policy	RolePermissionManagement.mapRolePermission(RoleModel role)
void	RolePermissionEvaluator.requireManage(RoleModel role)	Throws ForbiddenException if RolePermissionEvaluator.canManage(RoleModel) returns false.
void	RolePermissionEvaluator.requireMapClientScope(RoleModel role)	Throws ForbiddenException if RolePermissionEvaluator.canMapClientScope(RoleModel) returns false.
void	RolePermissionEvaluator.requireMapComposite(RoleModel role)	Throws ForbiddenException if RolePermissionEvaluator.canMapComposite(RoleModel) returns false.
void	RolePermissionEvaluator.requireMapRole(RoleModel role)	Throws ForbiddenException if RolePermissionEvaluator.canMapRole(RoleModel) returns false.
void	RolePermissionEvaluator.requireView(RoleModel role)	Throws ForbiddenException if RolePermissionEvaluator.canView(RoleModel) returns false.
Resource	RolePermissionManagement.resource(RoleModel role)
ResourceServer	RolePermissionManagement.resourceServer(RoleModel role)
Policy	RolePermissionManagement.rolePolicy(ResourceServer server, RoleModel role)
void	RolePermissionManagement.setPermissionsEnabled(RoleModel role, boolean enable)

Uses of RoleModel in org.keycloak.services.util

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

Modifier and Type	Method	Description
Stream<RoleModel>	DefaultClientSessionContext.getRolesStream()

Uses of RoleModel in org.keycloak.storage

Methods in org.keycloak.storage that return RoleModel

Modifier and Type	Method	Description
RoleModel	RoleStorageManager.addClientRole(ClientModel client, String name)
RoleModel	RoleStorageManager.addClientRole(ClientModel client, String id, String name)
RoleModel	RoleStorageManager.addRealmRole(RealmModel realm, String name)
RoleModel	RoleStorageManager.addRealmRole(RealmModel realm, String id, String name)
RoleModel	RoleStorageManager.getClientRole(ClientModel client, String name)
RoleModel	RoleStorageManager.getRealmRole(RealmModel realm, String name)
RoleModel	RoleStorageManager.getRoleById(RealmModel realm, String id)

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

Modifier and Type	Method	Description
Stream<RoleModel>	RoleStorageManager.getClientRolesStream(ClientModel client)
Stream<RoleModel>	RoleStorageManager.getClientRolesStream(ClientModel client, Integer first, Integer max)
Stream<RoleModel>	RoleStorageManager.getRealmRolesStream(RealmModel realm, Integer first, Integer max)
Stream<RoleModel>	RoleStorageManager.getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<RoleModel>	RoleStorageManager.searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)	Obtaining roles from an external role storage is time-bounded.
Stream<RoleModel>	RoleStorageManager.searchForClientRolesStream(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max)
Stream<RoleModel>	RoleStorageManager.searchForClientRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<RoleModel>	RoleStorageManager.searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)	Obtaining roles from an external role storage is time-bounded.

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

Modifier and Type	Method	Description
Stream<GroupModel>	GroupStorageManager.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserStorageManager.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
void	UserStorageManager.grantToAllUsers(RealmModel realm, RoleModel role)	UserQueryProvider methods implementation end here UserBulkUpdateProvider methods implementation start here
void	UserStorageManager.preRemove(RealmModel realm, RoleModel role)
default void	UserStorageProvider.preRemove(RealmModel realm, RoleModel role)	Callback when a role is removed.
boolean	RoleStorageManager.removeRole(RoleModel role)

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)	Deprecated. Use AbstractUserAdapter.getClientRoleMappingsStream(ClientModel) instead
Set<RoleModel>	AbstractUserAdapter.Streams.getClientRoleMappings(ClientModel app)
Stream<RoleModel>	AbstractInMemoryUserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	AbstractUserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	AbstractUserAdapter.Streams.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	AbstractUserAdapterFederatedStorage.getClientRoleMappingsStream(ClientModel app)	Gets role mappings from federated storage and automatically appends default roles.
protected Set<RoleModel>	AbstractUserAdapterFederatedStorage.getFederatedRoleMappings()	Deprecated. Use AbstractUserAdapterFederatedStorage.getFederatedRoleMappingsStream() instead
protected Stream<RoleModel>	AbstractUserAdapterFederatedStorage.getFederatedRoleMappingsStream()
Set<RoleModel>	AbstractUserAdapter.getRealmRoleMappings()	Deprecated. Use AbstractUserAdapter.getRealmRoleMappingsStream() instead
Set<RoleModel>	AbstractUserAdapter.Streams.getRealmRoleMappings()
Stream<RoleModel>	AbstractInMemoryUserAdapter.getRealmRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapter.getRealmRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapter.Streams.getRealmRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapterFederatedStorage.getRealmRoleMappingsStream()	Gets role mappings from federated storage and automatically appends default roles.
Set<RoleModel>	AbstractUserAdapter.getRoleMappings()	Deprecated. Use AbstractUserAdapter.getRoleMappingsStream() instead
Set<RoleModel>	AbstractUserAdapter.Streams.getRoleMappings()
protected Set<RoleModel>	AbstractUserAdapter.getRoleMappingsInternal()
protected Set<RoleModel>	AbstractUserAdapterFederatedStorage.getRoleMappingsInternal()
Stream<RoleModel>	AbstractInMemoryUserAdapter.getRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapter.getRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapter.Streams.getRoleMappingsStream()
Stream<RoleModel>	AbstractUserAdapterFederatedStorage.getRoleMappingsStream()	Gets role mappings from federated storage and automatically appends default roles.

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

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

Uses of RoleModel in org.keycloak.storage.client

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

Modifier and Type	Method	Description
final RoleModel	UnsupportedOperationsClientStorageAdapter.addRole(String name)
final RoleModel	UnsupportedOperationsClientStorageAdapter.addRole(String id, String name)
final RoleModel	UnsupportedOperationsClientStorageAdapter.getRole(String name)

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

Modifier and Type	Method	Description
final Stream<RoleModel>	UnsupportedOperationsClientStorageAdapter.getRolesStream()
final Stream<RoleModel>	UnsupportedOperationsClientStorageAdapter.getRolesStream(Integer first, Integer max)
final Stream<RoleModel>	UnsupportedOperationsClientStorageAdapter.searchForRolesStream(String search, Integer first, Integer max)

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

Modifier and Type	Method	Description
void	AbstractReadOnlyClientScopeAdapter.addScopeMapping(RoleModel role)
void	AbstractReadOnlyClientStorageAdapter.addScopeMapping(RoleModel role)
void	AbstractReadOnlyClientScopeAdapter.deleteScopeMapping(RoleModel role)
void	AbstractReadOnlyClientStorageAdapter.deleteScopeMapping(RoleModel role)
default void	ClientStorageProvider.preRemove(RealmModel realm, RoleModel role)	Callback when a role is removed.
final boolean	UnsupportedOperationsClientStorageAdapter.removeRole(RoleModel role)

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
Stream<RoleModel>	UserRoleMappingsFederatedStorage.getRoleMappingsStream(RealmModel realm, String userId)	Obtains the roles associated with the federated user identified by 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)
Stream<String>	UserRoleMappingsFederatedStorage.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer max)	Obtains the federated users that are members of the given role in the specified realm.
void	UserRoleMappingsFederatedStorage.grantRole(RealmModel realm, String userId, RoleModel role)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, RoleModel role)

Uses of RoleModel in org.keycloak.storage.jpa

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

Modifier and Type	Method	Description
Stream<RoleModel>	JpaUserFederatedStorageProvider.getRoleMappingsStream(RealmModel realm, String userId)

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

Modifier and Type	Method	Description
void	JpaUserFederatedStorageProvider.deleteRoleMapping(RealmModel realm, String userId, RoleModel role)
Stream<String>	JpaUserFederatedStorageProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer max)
void	JpaUserFederatedStorageProvider.grantRole(RealmModel realm, String userId, RoleModel role)
void	JpaUserFederatedStorageProvider.preRemove(RealmModel realm, RoleModel role)

Uses of RoleModel in org.keycloak.storage.ldap

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

Modifier and Type	Method	Description
Stream<UserModel>	LDAPStorageProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
void	LDAPStorageProvider.preRemove(RealmModel realm, RoleModel role)

Uses of RoleModel in org.keycloak.storage.ldap.mappers

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

Modifier and Type	Method	Description
List<UserModel>	AbstractLDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)
List<UserModel>	LDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)	Return empty list if doesn't support storing of roles

Uses of RoleModel in org.keycloak.storage.ldap.mappers.membership.group

Methods in org.keycloak.storage.ldap.mappers.membership.group with parameters of type RoleModel

Modifier and Type	Method	Description
boolean	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.hasRole(RoleModel role)

Uses of RoleModel in org.keycloak.storage.ldap.mappers.membership.role

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

Modifier and Type	Method	Description
Stream<RoleModel>	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.getClientRoleMappingsStream(ClientModel client)
protected Stream<RoleModel>	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.getLDAPRoleMappingsConverted()
Stream<RoleModel>	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.getRealmRoleMappingsStream()
Stream<RoleModel>	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.getRoleMappingsStream()

Methods in org.keycloak.storage.ldap.mappers.membership.role with parameters of type RoleModel

Modifier and Type	Method	Description
void	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.deleteRoleMapping(RoleModel role)
List<UserModel>	RoleLDAPStorageMapper.getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)
void	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.grantRole(RoleModel role)
boolean	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.hasRole(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.searchForClientRolesStream(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max)	Case-insensitive search for client roles that contain the given string in their name or their client's public identifier (clientId - (client_id in OIDC or entityID in SAML)).
Stream<RoleModel>	RoleLookupProvider.searchForClientRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)	Case-insensitive search for client roles that contain the given string in its name or their client's public identifier (clientId - (client_id in OIDC or entityID in SAML)).
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 Stream<UserModel>	UserQueryMethodsProvider.getRoleMembersStream(RealmModel realm, RoleModel role)	Obtains users that have the specified role.
default Stream<UserModel>	UserQueryMethodsProvider.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.