org.keycloak.services.resources.admin

Class RoleContainerResource

java.lang.Object

org.keycloak.services.resources.admin.RoleResource

org.keycloak.services.resources.admin.RoleContainerResource

public class RoleContainerResource
extends RoleResource

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected RoleContainerModel	roleContainer

Constructor Summary

Constructors

Constructor and Description
RoleContainerResource(javax.ws.rs.core.UriInfo uriInfo, RealmModel realm, RealmAuth auth, RoleContainerModel roleContainer, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method and Description
void	addComposites(String roleName, List<RoleRepresentation> roles) Add a composite to the role
javax.ws.rs.core.Response	createRole(RoleRepresentation rep) Create a new role for the realm or client
void	deleteComposites(String roleName, List<RoleRepresentation> roles) Remove roles from the role's composite
void	deleteRole(String roleName) Delete a role by name
Set<RoleRepresentation>	getClientRoleComposites(javax.ws.rs.core.UriInfo uriInfo, String roleName, String client) An app-level roles for the specified app for the role's composite
Set<RoleRepresentation>	getRealmRoleComposites(String roleName) Get realm-level roles of the role's composite
RoleRepresentation	getRole(String roleName) Get a role by name
Set<RoleRepresentation>	getRoleComposites(String roleName) Get composites of the role
List<RoleRepresentation>	getRoles() Get all roles for the realm or client
javax.ws.rs.core.Response	updateRole(String roleName, RoleRepresentation rep) Update a role by name

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

roleContainer

protected RoleContainerModel roleContainer

Constructor Detail

RoleContainerResource

public RoleContainerResource(javax.ws.rs.core.UriInfo uriInfo,
                             RealmModel realm,
                             RealmAuth auth,
                             RoleContainerModel roleContainer,
                             AdminEventBuilder adminEvent)

Method Detail

getRoles

public List<RoleRepresentation> getRoles()

Get all roles for the realm or client

Returns:

createRole

public javax.ws.rs.core.Response createRole(RoleRepresentation rep)

Create a new role for the realm or client

Parameters:

rep -

Returns:

getRole

public RoleRepresentation getRole(String roleName)

Get a role by name

Parameters:

roleName - role's name (not id!)

Returns:

deleteRole

public void deleteRole(String roleName)

Delete a role by name

Parameters:

roleName - role's name (not id!)

updateRole

public javax.ws.rs.core.Response updateRole(String roleName,
                                            RoleRepresentation rep)

Update a role by name

Parameters:

roleName - role's name (not id!)

rep -

Returns:

addComposites

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

Add a composite to the role

Parameters:

roleName - role's name (not id!)

roles -

getRoleComposites

public Set<RoleRepresentation> getRoleComposites(String roleName)

Get composites of the role

Parameters:

roleName - role's name (not id!)

Returns:

getRealmRoleComposites

public Set<RoleRepresentation> getRealmRoleComposites(String roleName)

Get realm-level roles of the role's composite

Parameters:

roleName - role's name (not id!)

Returns:

getClientRoleComposites

public Set<RoleRepresentation> getClientRoleComposites(@Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       String roleName,
                                                       String client)

An app-level roles for the specified app for the role's composite

Parameters:

roleName - role's name (not id!)

client -

Returns:

deleteComposites

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

Remove roles from the role's composite

Parameters:

roleName - role's name (not id!)

roles - roles to remove