Uses of Class
org.keycloak.representations.idm.RoleRepresentation

Packages that use RoleRepresentation

Package	Description
org.keycloak.admin.client.resource
org.keycloak.exportimport.util
org.keycloak.models.utils
org.keycloak.partialimport
org.keycloak.representations.idm
org.keycloak.services.resources.admin

Uses of RoleRepresentation in org.keycloak.admin.client.resource

Methods in org.keycloak.admin.client.resource that return RoleRepresentation

Modifier and Type	Method	Description
RoleRepresentation	RoleByIdResource.getRole(String id)
RoleRepresentation	RoleResource.toRepresentation()

Methods in org.keycloak.admin.client.resource that return types with arguments of type RoleRepresentation

Modifier and Type	Method	Description
Set<RoleRepresentation>	RoleByIdResource.getClientRoleComposites(String id, String clientUuid)
Set<RoleRepresentation>	RoleResource.getClientRoleComposites(String clientUuid)
Set<RoleRepresentation>	RoleByIdResource.getRealmRoleComposites(String id)
Set<RoleRepresentation>	RoleResource.getRealmRoleComposites()
Set<RoleRepresentation>	RoleByIdResource.getRoleComposites(String id)
Set<RoleRepresentation>	RoleResource.getRoleComposites()
List<RoleRepresentation>	RolesResource.list()
List<RoleRepresentation>	RolesResource.list(boolean briefRepresentation)
List<RoleRepresentation>	RolesResource.list(Integer firstResult, Integer maxResults)	Get roles by pagination params.
List<RoleRepresentation>	RolesResource.list(Integer firstResult, Integer maxResults, boolean briefRepresentation)	Get roles by pagination params.
List<RoleRepresentation>	RolesResource.list(String search, boolean briefRepresentation)	Get roles by pagination params.
List<RoleRepresentation>	RolesResource.list(String search, Integer firstResult, Integer maxResults)	Get roles by pagination params.
List<RoleRepresentation>	RolesResource.list(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)	Get roles by pagination params.
List<RoleRepresentation>	RoleScopeResource.listAll()
List<RoleRepresentation>	RoleScopeResource.listAvailable()
List<RoleRepresentation>	RoleScopeResource.listEffective()
List<RoleRepresentation>	RoleScopeResource.listEffective(boolean briefRepresentation)
Set<RoleRepresentation>	RoleByIdResource.searchRoleComposites(String id, String search, Integer first, Integer max)

Methods in org.keycloak.admin.client.resource with parameters of type RoleRepresentation

Modifier and Type	Method	Description
void	RolesResource.create(RoleRepresentation roleRepresentation)
void	RoleResource.update(RoleRepresentation roleRepresentation)
void	RoleByIdResource.updateRole(String id, RoleRepresentation rep)

Method parameters in org.keycloak.admin.client.resource with type arguments of type RoleRepresentation

Modifier and Type	Method	Description
void	RoleScopeResource.add(List<RoleRepresentation> rolesToAdd)
void	RoleByIdResource.addComposites(String id, List<RoleRepresentation> roles)
void	RoleResource.addComposites(List<RoleRepresentation> rolesToAdd)
void	RoleByIdResource.deleteComposites(String id, List<RoleRepresentation> roles)
void	RoleResource.deleteComposites(List<RoleRepresentation> rolesToRemove)
void	RoleScopeResource.remove(List<RoleRepresentation> rolesToRemove)

Uses of RoleRepresentation in org.keycloak.exportimport.util

Methods in org.keycloak.exportimport.util that return RoleRepresentation

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

Methods in org.keycloak.exportimport.util that return types with arguments of type RoleRepresentation

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

Uses of RoleRepresentation in org.keycloak.models.utils

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

Modifier and Type	Method	Description
static RoleRepresentation	ModelToRepresentation.toBriefRepresentation(RoleModel role)
static RoleRepresentation	ModelToRepresentation.toRepresentation(RoleModel role)

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

Modifier and Type	Method	Description
static RoleModel	RepresentationToModel.createRole(RealmModel newRealm, RoleRepresentation roleRep)

Uses of RoleRepresentation in org.keycloak.partialimport

Methods in org.keycloak.partialimport that return types with arguments of type RoleRepresentation

Modifier and Type	Method	Description
Map<String,List<RoleRepresentation>>	ClientRolesPartialImport.getRepList(PartialImportRepresentation partialImportRep)
List<RoleRepresentation>	RealmRolesPartialImport.getRepList(PartialImportRepresentation partialImportRep)
Map<String,Set<RoleRepresentation>>	ClientRolesPartialImport.getToOverwrite()
Set<RoleRepresentation>	RealmRolesPartialImport.getToOverwrite()
Map<String,Set<RoleRepresentation>>	ClientRolesPartialImport.getToSkip()
Set<RoleRepresentation>	RealmRolesPartialImport.getToSkip()

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

Modifier and Type	Method	Description
PartialImportResult	ClientRolesPartialImport.added(String clientId, String modelId, RoleRepresentation roleRep)
void	RealmRolesPartialImport.create(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)
void	ClientRolesPartialImport.deleteRole(RealmModel realm, String clientId, RoleRepresentation roleRep)
boolean	ClientRolesPartialImport.exists(RealmModel realm, KeycloakSession session, String clientId, RoleRepresentation roleRep)
boolean	RealmRolesPartialImport.exists(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)
String	ClientRolesPartialImport.existsMessage(String clientId, RoleRepresentation roleRep)
String	RealmRolesPartialImport.existsMessage(RealmModel realm, RoleRepresentation roleRep)
String	ClientRolesPartialImport.getCombinedName(String clientId, RoleRepresentation roleRep)
String	RealmRolesPartialImport.getModelId(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)
String	ClientRolesPartialImport.getName(RoleRepresentation roleRep)
String	RealmRolesPartialImport.getName(RoleRepresentation roleRep)
PartialImportResult	ClientRolesPartialImport.overwritten(String clientId, String modelId, RoleRepresentation roleRep)
void	RealmRolesPartialImport.remove(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)
PartialImportResult	ClientRolesPartialImport.skipped(String clientId, String modelId, RoleRepresentation roleRep)

Uses of RoleRepresentation in org.keycloak.representations.idm

Fields in org.keycloak.representations.idm declared as RoleRepresentation

Modifier and Type	Field	Description
protected RoleRepresentation	RealmRepresentation.defaultRole

Fields in org.keycloak.representations.idm with type parameters of type RoleRepresentation

Modifier and Type	Field	Description
protected Map<String,List<RoleRepresentation>>	RolesRepresentation.application	Deprecated.
protected Map<String,List<RoleRepresentation>>	RolesRepresentation.client
protected List<RoleRepresentation>	ClientMappingsRepresentation.mappings
protected List<RoleRepresentation>	RolesRepresentation.realm
protected List<RoleRepresentation>	MappingsRepresentation.realmMappings

Methods in org.keycloak.representations.idm that return RoleRepresentation

Modifier and Type	Method	Description
RoleRepresentation	RealmRepresentation.getDefaultRole()
RoleRepresentation	RoleRepresentation.singleAttribute(String name, String value)

Methods in org.keycloak.representations.idm that return types with arguments of type RoleRepresentation

Modifier and Type	Method	Description
Map<String,List<RoleRepresentation>>	RolesRepresentation.getApplication()	Deprecated.
Map<String,List<RoleRepresentation>>	RolesRepresentation.getClient()
List<RoleRepresentation>	ClientMappingsRepresentation.getMappings()
List<RoleRepresentation>	RolesRepresentation.getRealm()
List<RoleRepresentation>	MappingsRepresentation.getRealmMappings()

Methods in org.keycloak.representations.idm with parameters of type RoleRepresentation

Modifier and Type	Method	Description
void	RealmRepresentation.setDefaultRole(RoleRepresentation defaultRole)

Method parameters in org.keycloak.representations.idm with type arguments of type RoleRepresentation

Modifier and Type	Method	Description
void	RolesRepresentation.setClient(Map<String,List<RoleRepresentation>> client)
void	ClientMappingsRepresentation.setMappings(List<RoleRepresentation> mappings)
void	RolesRepresentation.setRealm(List<RoleRepresentation> realm)
void	MappingsRepresentation.setRealmMappings(List<RoleRepresentation> realmMappings)

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

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

Modifier and Type	Method	Description
RoleRepresentation	RoleByIdResource.getRole(String id)	Get a specific role's representation
RoleRepresentation	RoleContainerResource.getRole(String roleName)	Get a role by name
protected RoleRepresentation	RoleResource.getRole(RoleModel roleModel)

Methods in org.keycloak.services.resources.admin that return types with arguments of type RoleRepresentation

Modifier and Type	Method	Description
Stream<RoleRepresentation>	ClientRoleMappingsResource.getAvailableClientRoleMappings()	Get available client-level roles that can be mapped to the user or group
Stream<RoleRepresentation>	ScopeMappedClientResource.getAvailableClientScopeMappings()	The available client-level roles Returns the roles for the client that can be associated with the client's scope
Stream<RoleRepresentation>	RoleMapperResource.getAvailableRealmRoleMappings()	Get realm-level roles that can be mapped
Stream<RoleRepresentation>	ScopeMappedResource.getAvailableRealmScopeMappings()	Get realm-level roles that are available to attach to this client's scope
Stream<RoleRepresentation>	RoleByIdResource.getClientRoleComposites(String id, String clientUuid)	Get client-level roles for the client that are in the role's composite
Stream<RoleRepresentation>	RoleContainerResource.getClientRoleComposites(String roleName, String clientUuid)	Get client-level roles for the client that are in the role's composite
protected Stream<RoleRepresentation>	RoleResource.getClientRoleComposites(ClientModel app, RoleModel role)
Stream<RoleRepresentation>	ClientRoleMappingsResource.getClientRoleMappings()	Get client-level role mappings for the user, and the app
Stream<RoleRepresentation>	ScopeMappedClientResource.getClientScopeMappings()	Get the roles associated with a client's scope Returns roles for the client.
Stream<RoleRepresentation>	ClientRoleMappingsResource.getCompositeClientRoleMappings(boolean briefRepresentation)	Get effective client-level role mappings This recurses any composite roles
Stream<RoleRepresentation>	ScopeMappedClientResource.getCompositeClientScopeMappings(boolean briefRepresentation)	Get effective client roles Returns the roles for the client that are associated with the client's scope.
Stream<RoleRepresentation>	RoleMapperResource.getCompositeRealmRoleMappings(boolean briefRepresentation)	Get effective realm-level role mappings This will recurse all composite roles to get the result.
Stream<RoleRepresentation>	ScopeMappedResource.getCompositeRealmScopeMappings(boolean briefRepresentation)	Get effective realm-level roles associated with the client's scope What this does is recurse any composite roles associated with the client's scope and adds the roles to this lists.
Stream<RoleRepresentation>	ClientScopeEvaluateScopeMappingsResource.getGrantedScopeMappings()	Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.
Stream<RoleRepresentation>	ClientScopeEvaluateScopeMappingsResource.getNotGrantedScopeMappings()	Get roles, which this client doesn't have scope for and can't have them in the accessToken issued for him.
Stream<RoleRepresentation>	RoleByIdResource.getRealmRoleComposites(String id)	Get realm-level roles that are in the role's composite
Stream<RoleRepresentation>	RoleContainerResource.getRealmRoleComposites(String roleName)	Get realm-level roles of the role's composite
protected Stream<RoleRepresentation>	RoleResource.getRealmRoleComposites(RoleModel role)
Stream<RoleRepresentation>	RoleMapperResource.getRealmRoleMappings()	Get realm-level role mappings
Stream<RoleRepresentation>	ScopeMappedResource.getRealmScopeMappings()	Get realm-level roles associated with the client's scope
Stream<RoleRepresentation>	RoleByIdResource.getRoleComposites(String id, String search, Integer first, Integer max)	Get role's children Returns a set of role's children provided the role is a composite.
Stream<RoleRepresentation>	RoleContainerResource.getRoleComposites(String roleName)	Get composites of the role
Stream<RoleRepresentation>	RoleContainerResource.getRoles(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)	Get all roles for the realm or client

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

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	RoleContainerResource.createRole(RoleRepresentation rep)	Create a new role for the realm or client
void	RoleByIdResource.updateRole(String id, RoleRepresentation rep)	Update the role
jakarta.ws.rs.core.Response	RoleContainerResource.updateRole(String roleName, RoleRepresentation rep)	Update a role by name
protected void	RoleResource.updateRole(RoleRepresentation rep, RoleModel role, RealmModel realm, KeycloakSession session)

Method parameters in org.keycloak.services.resources.admin with type arguments of type RoleRepresentation

Modifier and Type	Method	Description
void	ClientRoleMappingsResource.addClientRoleMapping(List<RoleRepresentation> roles)	Add client-level roles to the user or group role mapping
void	ScopeMappedClientResource.addClientScopeMapping(List<RoleRepresentation> roles)	Add client-level roles to the client's scope
void	RoleByIdResource.addComposites(String id, List<RoleRepresentation> roles)	Make the role a composite role by associating some child roles
void	RoleContainerResource.addComposites(String roleName, List<RoleRepresentation> roles)	Add a composite to the role
protected void	RoleResource.addComposites(AdminPermissionEvaluator auth, AdminEventBuilder adminEvent, jakarta.ws.rs.core.UriInfo uriInfo, List<RoleRepresentation> roles, RoleModel role)
void	RoleMapperResource.addRealmRoleMappings(List<RoleRepresentation> roles)	Add realm-level role mappings to the user
void	ScopeMappedResource.addRealmScopeMappings(List<RoleRepresentation> roles)	Add a set of realm-level roles to the client's scope
void	ClientRoleMappingsResource.deleteClientRoleMapping(List<RoleRepresentation> roles)	Delete client-level roles from user or group role mapping
void	ScopeMappedClientResource.deleteClientScopeMapping(List<RoleRepresentation> roles)	Remove client-level roles from the client's scope.
void	RoleByIdResource.deleteComposites(String id, List<RoleRepresentation> roles)	Remove a set of roles from the role's composite
void	RoleContainerResource.deleteComposites(String roleName, List<RoleRepresentation> roles)	Remove roles from the role's composite
protected void	RoleResource.deleteComposites(AdminEventBuilder adminEvent, jakarta.ws.rs.core.UriInfo uriInfo, List<RoleRepresentation> roles, RoleModel role)
void	RoleMapperResource.deleteRealmRoleMappings(List<RoleRepresentation> roles)	Delete realm-level role mappings
void	ScopeMappedResource.deleteRealmScopeMappings(List<RoleRepresentation> roles)	Remove a set of realm-level roles from the client's scope