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

public class ClientRoleMappingsResource
extends Object

Version:: $Revision: 1 $
Author:: Bill Burke

Field Summary

Fields
Modifier and Type	Field	Description
`protected AdminEventBuilder`	`adminEvent`
`protected AdminPermissionEvaluator`	`auth`
`protected org.keycloak.models.ClientModel`	`client`
`protected static org.jboss.logging.Logger`	`logger`
`protected AdminPermissionEvaluator.RequirePermissionCheck`	`managePermission`
`protected org.keycloak.models.RealmModel`	`realm`
`protected org.keycloak.models.KeycloakSession`	`session`
`protected org.keycloak.models.RoleMapperModel`	`user`
`protected AdminPermissionEvaluator.RequirePermissionCheck`	`viewPermission`

Constructor Summary

Constructors
Constructor	Description
`ClientRoleMappingsResource(javax.ws.rs.core.UriInfo uriInfo, org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, AdminPermissionEvaluator auth, org.keycloak.models.RoleMapperModel user, org.keycloak.models.ClientModel client, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck manageCheck, AdminPermissionEvaluator.RequirePermissionCheck viewCheck)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addClientRoleMapping(List<org.keycloak.representations.idm.RoleRepresentation> roles)`	Add client-level roles to the user role mapping
`void`	`deleteClientRoleMapping(List<org.keycloak.representations.idm.RoleRepresentation> roles)`	Delete client-level roles from user role mapping
`Stream<org.keycloak.representations.idm.RoleRepresentation>`	`getAvailableClientRoleMappings()`	Get available client-level roles that can be mapped to the user
`Stream<org.keycloak.representations.idm.RoleRepresentation>`	`getClientRoleMappings()`	Get client-level role mappings for the user, and the app
`Stream<org.keycloak.representations.idm.RoleRepresentation>`	`getCompositeClientRoleMappings(boolean briefRepresentation)`	Get effective client-level role mappings This recurses any composite roles

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

session

protected org.keycloak.models.KeycloakSession session

realm

protected org.keycloak.models.RealmModel realm

auth

protected AdminPermissionEvaluator auth

user

protected org.keycloak.models.RoleMapperModel user

client

protected org.keycloak.models.ClientModel client

adminEvent
```
protected AdminEventBuilder adminEvent
```

managePermission

protected AdminPermissionEvaluator.RequirePermissionCheck managePermission

viewPermission

protected AdminPermissionEvaluator.RequirePermissionCheck viewPermission

Constructor Detail

ClientRoleMappingsResource

public ClientRoleMappingsResource(javax.ws.rs.core.UriInfo uriInfo,
                                  org.keycloak.models.KeycloakSession session,
                                  org.keycloak.models.RealmModel realm,
                                  AdminPermissionEvaluator auth,
                                  org.keycloak.models.RoleMapperModel user,
                                  org.keycloak.models.ClientModel client,
                                  AdminEventBuilder adminEvent,
                                  AdminPermissionEvaluator.RequirePermissionCheck manageCheck,
                                  AdminPermissionEvaluator.RequirePermissionCheck viewCheck)

Method Detail

getClientRoleMappings

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

Get client-level role mappings for the user, and the app

Returns:

getCompositeClientRoleMappings

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

Get effective client-level role mappings This recurses any composite roles

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

getAvailableClientRoleMappings

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

Get available client-level roles that can be mapped to the user

Returns:

addClientRoleMapping

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

Add client-level roles to the user role mapping

Parameters:: roles -

deleteClientRoleMapping

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

Delete client-level roles from user role mapping

Parameters:: roles -

Class ClientRoleMappingsResource