Package org.keycloak.admin.client.resource

Interface RoleByIdResource

public interface RoleByIdResource

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

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	Description
void	addComposites(String id, List<org.keycloak.representations.idm.RoleRepresentation> roles)
void	deleteComposites(String id, List<org.keycloak.representations.idm.RoleRepresentation> roles)
void	deleteRole(String id)
Set<org.keycloak.representations.idm.RoleRepresentation>	getClientRoleComposites(String id, String clientUuid)
Set<org.keycloak.representations.idm.RoleRepresentation>	getRealmRoleComposites(String id)
org.keycloak.representations.idm.RoleRepresentation	getRole(String id)
Set<org.keycloak.representations.idm.RoleRepresentation>	getRoleComposites(String id)
Set<org.keycloak.representations.idm.RoleRepresentation>	searchRoleComposites(String id, String search, Integer first, Integer max)
void	updateRole(String id, org.keycloak.representations.idm.RoleRepresentation rep)

Method Details

getRole

@Path("{role-id}")
@GET
@Produces("application/json")
org.keycloak.representations.idm.RoleRepresentation getRole(@PathParam("role-id")
 String id)

deleteRole

@Path("{role-id}")
@DELETE
void deleteRole(@PathParam("role-id")
 String id)

updateRole

@Path("{role-id}")
@PUT
@Consumes("application/json")
void updateRole(@PathParam("role-id")
 String id,
 org.keycloak.representations.idm.RoleRepresentation rep)

addComposites

@Path("{role-id}/composites")
@POST
@Consumes("application/json")
void addComposites(@PathParam("role-id")
 String id,
 List<org.keycloak.representations.idm.RoleRepresentation> roles)

getRoleComposites

@Path("{role-id}/composites")
@GET
@Produces("application/json")
Set<org.keycloak.representations.idm.RoleRepresentation> getRoleComposites(@PathParam("role-id")
 String id)

searchRoleComposites

@Path("{role-id}/composites")
@GET
@Produces("application/json")
Set<org.keycloak.representations.idm.RoleRepresentation> searchRoleComposites(@PathParam("role-id")
 String id,
 @QueryParam("search")
 String search,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

getRealmRoleComposites

@Path("{role-id}/composites/realm")
@GET
@Produces("application/json")
Set<org.keycloak.representations.idm.RoleRepresentation> getRealmRoleComposites(@PathParam("role-id")
 String id)

getClientRoleComposites

@Path("{role-id}/composites/clients/{clientUuid}")
@GET
@Produces("application/json")
Set<org.keycloak.representations.idm.RoleRepresentation> getClientRoleComposites(@PathParam("role-id")
 String id,
 @PathParam("clientUuid")
 String clientUuid)

deleteComposites

@Path("{role-id}/composites")
@DELETE
@Consumes("application/json")
void deleteComposites(@PathParam("role-id")
 String id,
 List<org.keycloak.representations.idm.RoleRepresentation> roles)