Interface RoleResource
public interface RoleResource
- Author:
- rodrigo.sasaki@icarros.com.br
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addComposites
(List<RoleRepresentation> rolesToAdd) void
deleteComposites
(List<RoleRepresentation> rolesToRemove) getClientRoleComposites
(String clientUuid) Returns indicator if the fine grain permissions are enabled or not.Get role groups.getRoleGroupMembers
(Integer firstResult, Integer maxResults) Get role groups.Deprecated.getRoleUserMembers
(Integer firstResult, Integer maxResults) Deprecated.please usegetUserMembers(Integer, Integer)
Get role members.getUserMembers
(Boolean briefRepresentation, Integer firstResult, Integer maxResults) Get role members.getUserMembers
(Integer firstResult, Integer maxResults) Get role members.void
remove()
Enables or disables the fine grain permissions feature.void
update
(RoleRepresentation roleRepresentation)
-
Method Details
-
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 theManagementPermissionReference
.- 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
-
update
-
remove
@DELETE void remove() -
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 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 offsetmaxResults
- Pagination size- Returns:
- a list of users with the given role
-
getUserMembers
@GET @Path("users") @Produces("application/json") List<UserRepresentation> getUserMembers(@QueryParam("briefRepresentation") Boolean briefRepresentation, @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:
briefRepresentation
- If the user should be returned in brief or full representation. Parameter available since Keycloak server 26. Will be ignored on older Keycloak versions with the default value false.firstResult
- Pagination offsetmaxResults
- Pagination size- Returns:
- a list of users with the given role
-
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 offsetmaxResults
- Pagination size- Returns:
- a list of groups with the given role
-
getRoleUserMembers
@GET @Path("users") @Produces("application/json") @Deprecated Set<UserRepresentation> getRoleUserMembers()Deprecated.please usegetUserMembers()
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 usegetUserMembers(Integer, Integer)
Get role members.Returns users that have the given role, paginated according to the query parameters.
- Parameters:
firstResult
- Pagination offsetmaxResults
- Pagination size- Returns:
- a set of users with the given role
-
getUserMembers()