java.lang.Object
- org.keycloak.services.resources.admin.RoleMapperResource

```
public class RoleMapperResource
extends Object
```
Base resource for managing users

Version:

$Revision: 1 $

Author:

Bill Burke, Miguel P. Nunes

Field Summary

Fields
Modifier and Type	Field	Description
`protected org.keycloak.common.ClientConnection`	`clientConnection`
`protected javax.ws.rs.core.HttpHeaders`	`headers`
`protected static org.jboss.logging.Logger`	`logger`
`protected AdminPermissionEvaluator.RequirePermissionCheck`	`managePermission`
`protected org.keycloak.models.RealmModel`	`realm`
`protected org.keycloak.models.KeycloakSession`	`session`
`protected AdminPermissionEvaluator.RequirePermissionCheck`	`viewPermission`

Constructor Summary

Constructors
Constructor	Description
`RoleMapperResource(org.keycloak.models.KeycloakSession session, AdminPermissionEvaluator auth, org.keycloak.models.RoleMapperModel roleMapper, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck manageCheck, AdminPermissionEvaluator.RequirePermissionCheck viewCheck)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addRealmRoleMappings(List<org.keycloak.representations.idm.RoleRepresentation> roles)`	Add realm-level role mappings to the user
`void`	`deleteRealmRoleMappings(List<org.keycloak.representations.idm.RoleRepresentation> roles)`	Delete realm-level role mappings
`Stream<org.keycloak.representations.idm.RoleRepresentation>`	`getAvailableRealmRoleMappings()`	Get realm-level roles that can be mapped
`Stream<org.keycloak.representations.idm.RoleRepresentation>`	`getCompositeRealmRoleMappings(boolean briefRepresentation)`	Get effective realm-level role mappings This will recurse all composite roles to get the result.
`Stream<org.keycloak.representations.idm.RoleRepresentation>`	`getRealmRoleMappings()`	Get realm-level role mappings
`org.keycloak.representations.idm.MappingsRepresentation`	`getRoleMappings()`	Get role mappings
`ClientRoleMappingsResource`	`getUserClientRoleMappingsResource(String client)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final org.jboss.logging.Logger logger

realm

protected final org.keycloak.models.RealmModel realm

managePermission

protected final AdminPermissionEvaluator.RequirePermissionCheck managePermission

viewPermission

protected final AdminPermissionEvaluator.RequirePermissionCheck viewPermission

clientConnection

protected final org.keycloak.common.ClientConnection clientConnection

session

protected final org.keycloak.models.KeycloakSession session

headers

protected final javax.ws.rs.core.HttpHeaders headers

Constructor Detail

RoleMapperResource

public RoleMapperResource(org.keycloak.models.KeycloakSession session,
                          AdminPermissionEvaluator auth,
                          org.keycloak.models.RoleMapperModel roleMapper,
                          AdminEventBuilder adminEvent,
                          AdminPermissionEvaluator.RequirePermissionCheck manageCheck,
                          AdminPermissionEvaluator.RequirePermissionCheck viewCheck)

Method Detail

getRoleMappings

@GET
@Produces("application/json")
public org.keycloak.representations.idm.MappingsRepresentation getRoleMappings()

Get role mappings

Returns:

getRealmRoleMappings

@Path("realm")
@GET
@Produces("application/json")
public Stream<org.keycloak.representations.idm.RoleRepresentation> getRealmRoleMappings()

Get realm-level role mappings

Returns:

getCompositeRealmRoleMappings

@Path("realm/composite")
@GET
@Produces("application/json")
public Stream<org.keycloak.representations.idm.RoleRepresentation> getCompositeRealmRoleMappings(@QueryParam("briefRepresentation") @DefaultValue("true")
                                                                                                 boolean briefRepresentation)

Get effective realm-level role mappings This will recurse all composite roles to get the result.

Parameters:: briefRepresentation - if false, return roles with their attributes
Returns:

getAvailableRealmRoleMappings

@Path("realm/available")
@GET
@Produces("application/json")
public Stream<org.keycloak.representations.idm.RoleRepresentation> getAvailableRealmRoleMappings()

Get realm-level roles that can be mapped

Returns:

addRealmRoleMappings

@Path("realm")
@POST
@Consumes("application/json")
public void addRealmRoleMappings(List<org.keycloak.representations.idm.RoleRepresentation> roles)

Add realm-level role mappings to the user

Parameters:: roles - Roles to add

deleteRealmRoleMappings

@Path("realm")
@DELETE
@Consumes("application/json")
public void deleteRealmRoleMappings(List<org.keycloak.representations.idm.RoleRepresentation> roles)

Delete realm-level role mappings

Parameters:: roles -

getUserClientRoleMappingsResource

@Path("clients/{client}")
public ClientRoleMappingsResource getUserClientRoleMappingsResource(@PathParam("client")
                                                                    String client)

Class RoleMapperResource