org.keycloak.services.resources.admin

Class RoleByIdResource

java.lang.Object

org.keycloak.services.resources.admin.RoleResource

org.keycloak.services.resources.admin.RoleByIdResource

public class RoleByIdResource
extends RoleResource

Sometimes its easier to just interact with roles by their ID instead of container/role-name

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.jboss.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
RoleByIdResource(RealmModel realm, RealmAuth auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method and Description
void	addComposites(String id, List<RoleRepresentation> roles) Make the role a composite role by associating some child roles
void	deleteComposites(String id, List<RoleRepresentation> roles) Remove a set of roles from the role's composite
void	deleteRole(String id) Delete the role
Set<RoleRepresentation>	getClientByIdRoleComposites(String role, String client) Get client-level roles for the client that are in the role's composite
Set<RoleRepresentation>	getClientRoleComposites(String id, String client) Get client-level roles for the client that are in the role's composite
Set<RoleRepresentation>	getRealmRoleComposites(String id) Get realm-level roles that are in the role's composite
RoleRepresentation	getRole(String id) Get a specific role's representation
Set<RoleRepresentation>	getRoleComposites(String id) Get role's children Returns a set of role's children provided the role is a composite.
protected RoleModel	getRoleModel(String id)
void	updateRole(String id, RoleRepresentation rep) Update the role

Methods inherited from class org.keycloak.services.resources.admin.RoleResource

addComposites, deleteComposites, deleteRole, getClientRoleComposites, getRealmRoleComposites, getRole, getRoleComposites, updateRole

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

Constructor Detail

RoleByIdResource

public RoleByIdResource(RealmModel realm,
                        RealmAuth auth,
                        AdminEventBuilder adminEvent)

Method Detail

getRole

public RoleRepresentation getRole(String id)

Get a specific role's representation

Parameters:

id - id of role

Returns:

getRoleModel

protected RoleModel getRoleModel(String id)

deleteRole

public void deleteRole(String id)

Delete the role

Parameters:

id - id of role

updateRole

public void updateRole(String id,
                       RoleRepresentation rep)

Update the role

Parameters:

id - id of role

rep -

addComposites

public void addComposites(String id,
                          List<RoleRepresentation> roles)

Make the role a composite role by associating some child roles

Parameters:

id -

roles -

getRoleComposites

public Set<RoleRepresentation> getRoleComposites(String id)

Get role's children Returns a set of role's children provided the role is a composite.

Parameters:

id -

Returns:

getRealmRoleComposites

public Set<RoleRepresentation> getRealmRoleComposites(String id)

Get realm-level roles that are in the role's composite

Parameters:

id -

Returns:

getClientRoleComposites

public Set<RoleRepresentation> getClientRoleComposites(String id,
                                                       String client)

Get client-level roles for the client that are in the role's composite

Parameters:

id -

client -

Returns:

getClientByIdRoleComposites

public Set<RoleRepresentation> getClientByIdRoleComposites(String role,
                                                           String client)

Get client-level roles for the client that are in the role's composite

Parameters:

role -

client -

Returns:

deleteComposites

public void deleteComposites(String id,
                             List<RoleRepresentation> roles)

Remove a set of roles from the role's composite

Parameters:

id - Role id

roles - A set of roles to be removed