Package org.keycloak.admin.client.resource

Interface RoleResource

public interface RoleResource

Author:

rodrigo.sasaki@icarros.com.br

Method Summary

Modifier and Type	Method	Description
void	addComposites(List<RoleRepresentation> rolesToAdd)
void	deleteComposites(List<RoleRepresentation> rolesToRemove)
Set<RoleRepresentation>	getClientRoleComposites(String clientUuid)
ManagementPermissionReference	getPermissions()	Returns indicator if the fine grain permissions are enabled or not.
Set<RoleRepresentation>	getRealmRoleComposites()
Set<RoleRepresentation>	getRoleComposites()
Set<GroupRepresentation>	getRoleGroupMembers()	Get role groups
Set<GroupRepresentation>	getRoleGroupMembers(Integer firstResult, Integer maxResults)	Get role groups
Set<UserRepresentation>	getRoleUserMembers()	Deprecated. please use getUserMembers()
Set<UserRepresentation>	getRoleUserMembers(Integer firstResult, Integer maxResults)	Deprecated. please use getUserMembers(Integer, Integer)
List<UserRepresentation>	getUserMembers()	Get role members.
List<UserRepresentation>	getUserMembers(Integer firstResult, Integer maxResults)	Get role members.
void	remove()
ManagementPermissionReference	setPermissions(ManagementPermissionRepresentation status)	Enables or disables the fine grain permissions feature.
RoleRepresentation	toRepresentation()
void	update(RoleRepresentation roleRepresentation)

Method Detail

setPermissions

@PUT
@Path("/management/permissions")
@Consumes("application/json")
@Produces("application/json")
ManagementPermissionReference setPermissions(ManagementPermissionRepresentation status)

Enables or disables the fine grain permissions feature. Returns the updated status of the server in the ManagementPermissionReference.

Parameters:

status - status request to apply

Returns:

permission reference indicating the updated status

getPermissions

@GET
@Path("/management/permissions")
@Produces("application/json")
ManagementPermissionReference getPermissions()

Returns indicator if the fine grain permissions are enabled or not.

Returns:

current representation of the permissions feature

toRepresentation

@GET
@Produces("application/json")
RoleRepresentation toRepresentation()

update

@PUT
@Consumes("application/json")
void update(RoleRepresentation roleRepresentation)

remove

@DELETE
void remove()

getRoleComposites

@GET
@Path("composites")
@Produces("application/json")
Set<RoleRepresentation> getRoleComposites()

getRealmRoleComposites

@GET
@Path("composites/realm")
@Produces("application/json")
Set<RoleRepresentation> getRealmRoleComposites()

getClientRoleComposites

@GET
@Path("composites/clients/{clientUuid}")
@Produces("application/json")
Set<RoleRepresentation> getClientRoleComposites(@PathParam("clientUuid")
                                                String clientUuid)

addComposites

@POST
@Path("composites")
@Consumes("application/json")
void addComposites(List<RoleRepresentation> rolesToAdd)

deleteComposites

@DELETE
@Path("composites")
@Consumes("application/json")
void deleteComposites(List<RoleRepresentation> rolesToRemove)

getUserMembers

@GET
@Path("users")
@Produces("application/json")
List<UserRepresentation> getUserMembers()

Get role members.

Returns users that have the given role, sorted by username ascending.

Note: This method just returns the first 100 users. In order to retrieve all users, use paging (see getUserMembers(Integer, Integer)).

Returns:

a list of users with the given role

getUserMembers

@GET
@Path("users")
@Produces("application/json")
List<UserRepresentation> getUserMembers(@QueryParam("first")
                                        Integer firstResult,
                                        @QueryParam("max")
                                        Integer maxResults)

Get role members.

Returns users that have the given role, sorted by username ascending, paginated according to the query parameters.

Parameters:

firstResult - Pagination offset

maxResults - Pagination size

Returns:

a list of users with the given role

getRoleGroupMembers

@GET
@Path("groups")
@Produces("application/json")
Set<GroupRepresentation> getRoleGroupMembers()

Get role groups

Returns groups that have the given role

Returns:

a list of groups with the given role

getRoleGroupMembers

@GET
@Path("groups")
@Produces("application/json")
Set<GroupRepresentation> getRoleGroupMembers(@QueryParam("first")
                                             Integer firstResult,
                                             @QueryParam("max")
                                             Integer maxResults)

Get role groups

Returns groups that have the given role, paginated according to the query parameters

Parameters:

firstResult - Pagination offset

maxResults - Pagination size

Returns:

a list of groups with the given role

getRoleUserMembers

@GET
@Path("users")
@Produces("application/json")
@Deprecated
Set<UserRepresentation> getRoleUserMembers()

Deprecated.

please use getUserMembers()

Get role members

Returns users that have the given role

Returns:

a set of users with the given role

getRoleUserMembers

@GET
@Path("users")
@Produces("application/json")
@Deprecated
Set<UserRepresentation> getRoleUserMembers(@QueryParam("first")
                                           Integer firstResult,
                                           @QueryParam("max")
                                           Integer maxResults)

Deprecated.

please use getUserMembers(Integer, Integer)

Get role members

Returns users that have the given role, paginated according to the query parameters

Parameters:

firstResult - Pagination offset

maxResults - Pagination size

Returns:

a set of users with the given role