org.keycloak.services.resources.admin

Class RoleMapperResource

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 and Description
protected ClientConnection	clientConnection
protected javax.ws.rs.core.HttpHeaders	headers
protected static org.jboss.logging.Logger	logger
protected AdminPermissionEvaluator.RequirePermissionCheck	managePermission
protected RealmModel	realm
protected KeycloakSession	session
protected AdminPermissionEvaluator.RequirePermissionCheck	viewPermission

Constructor Summary

Constructors

Constructor and Description
RoleMapperResource(RealmModel realm, AdminPermissionEvaluator auth, RoleMapperModel roleMapper, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck manageCheck, AdminPermissionEvaluator.RequirePermissionCheck viewCheck)

Method Summary

Modifier and Type	Method and Description
void	addRealmRoleMappings(List<RoleRepresentation> roles) Add realm-level role mappings to the user
void	deleteRealmRoleMappings(List<RoleRepresentation> roles) Delete realm-level role mappings
Stream<RoleRepresentation>	getAvailableRealmRoleMappings() Get realm-level roles that can be mapped
Stream<RoleRepresentation>	getCompositeRealmRoleMappings(boolean briefRepresentation) Get effective realm-level role mappings This will recurse all composite roles to get the result.
Stream<RoleRepresentation>	getRealmRoleMappings() Get realm-level role mappings
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 RealmModel realm

managePermission

protected AdminPermissionEvaluator.RequirePermissionCheck managePermission

viewPermission

protected AdminPermissionEvaluator.RequirePermissionCheck viewPermission

clientConnection

@Context
protected ClientConnection clientConnection

session

@Context
protected KeycloakSession session

headers

@Context
protected javax.ws.rs.core.HttpHeaders headers

Constructor Detail

RoleMapperResource

public RoleMapperResource(RealmModel realm,
                          AdminPermissionEvaluator auth,
                          RoleMapperModel roleMapper,
                          AdminEventBuilder adminEvent,
                          AdminPermissionEvaluator.RequirePermissionCheck manageCheck,
                          AdminPermissionEvaluator.RequirePermissionCheck viewCheck)

Method Detail

getRoleMappings

@GET
 @Produces(value="application/json")
public MappingsRepresentation getRoleMappings()

Get role mappings

Returns:

getRealmRoleMappings

@Path(value="realm")
 @GET
 @Produces(value="application/json")
public Stream<RoleRepresentation> getRealmRoleMappings()

Get realm-level role mappings

Returns:

getCompositeRealmRoleMappings

@Path(value="realm/composite")
 @GET
 @Produces(value="application/json")
public Stream<RoleRepresentation> getCompositeRealmRoleMappings(@QueryParam(value="briefRepresentation") @DefaultValue(value="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(value="realm/available")
 @GET
 @Produces(value="application/json")
public Stream<RoleRepresentation> getAvailableRealmRoleMappings()

Get realm-level roles that can be mapped

Returns:

addRealmRoleMappings

@Path(value="realm")
 @POST
 @Consumes(value="application/json")
public void addRealmRoleMappings(List<RoleRepresentation> roles)

Add realm-level role mappings to the user

Parameters:

roles - Roles to add

deleteRealmRoleMappings

@Path(value="realm")
 @DELETE
 @Consumes(value="application/json")
public void deleteRealmRoleMappings(List<RoleRepresentation> roles)

Delete realm-level role mappings

Parameters:

roles -

getUserClientRoleMappingsResource

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