Class RoleByIdResource
java.lang.Object
org.keycloak.services.resources.admin.RoleResource
org.keycloak.services.resources.admin.RoleByIdResource
Sometimes its easier to just interact with roles by their ID instead of container/role-name
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
-
Constructor Summary
ConstructorDescriptionRoleByIdResource
(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addComposites
(String id, List<RoleRepresentation> roles) Make the role a composite role by associating some child rolesvoid
deleteComposites
(String id, List<RoleRepresentation> roles) Remove a set of roles from the role's compositevoid
deleteRole
(String id) Delete the rolegetClientRoleComposites
(String id, String clientUuid) Get client-level roles for the client that are in the role's compositeReturn object stating whether role Authorization permissions have been initialized or not and a referenceGet realm-level roles that are in the role's compositeGet a specific role's representationgetRoleComposites
(String id, String search, Integer first, Integer max) Get role's children Returns a set of role's children provided the role is a composite.protected RoleModel
getRoleModel
(String id) Return object stating whether role Authorization permissions have been initialized or not and a referencetoMgmtRef
(RoleModel role, AdminPermissionManagement permissions) void
updateRole
(String id, RoleRepresentation rep) Update the roleMethods inherited from class org.keycloak.services.resources.admin.RoleResource
addComposites, deleteComposites, deleteRole, getClientRoleComposites, getRealmRoleComposites, getRole, updateRole
-
Field Details
-
logger
protected static final org.jboss.logging.Logger logger
-
-
Constructor Details
-
RoleByIdResource
public RoleByIdResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
-
-
Method Details
-
getRole
@Path("{role-id}") @GET @Produces("application/json") public RoleRepresentation getRole(@PathParam("role-id") String id) Get a specific role's representation- Parameters:
id
- id of role- Returns:
-
getRoleModel
-
deleteRole
Delete the role- Parameters:
id
- id of role
-
updateRole
@Path("{role-id}") @PUT @Consumes("application/json") public void updateRole(@PathParam("role-id") String id, RoleRepresentation rep) Update the role- Parameters:
id
- id of rolerep
-
-
addComposites
@Path("{role-id}/composites") @POST @Consumes("application/json") public void addComposites(@PathParam("role-id") String id, List<RoleRepresentation> roles) Make the role a composite role by associating some child roles- Parameters:
id
-roles
-
-
getRoleComposites
@Path("{role-id}/composites") @GET @Produces("application/json") public Stream<RoleRepresentation> getRoleComposites(@PathParam("role-id") String id, @QueryParam("search") String search, @QueryParam("first") Integer first, @QueryParam("max") Integer max) Get role's children Returns a set of role's children provided the role is a composite.- Parameters:
id
-- Returns:
-
getRealmRoleComposites
@Path("{role-id}/composites/realm") @GET @Produces("application/json") public Stream<RoleRepresentation> getRealmRoleComposites(@PathParam("role-id") String id) Get realm-level roles that are in the role's composite- Parameters:
id
-- Returns:
-
getClientRoleComposites
@Path("{role-id}/composites/clients/{clientUuid}") @GET @Produces("application/json") public Stream<RoleRepresentation> getClientRoleComposites(@PathParam("role-id") String id, @PathParam("clientUuid") String clientUuid) Get client-level roles for the client that are in the role's composite- Parameters:
id
-clientUuid
-- Returns:
-
deleteComposites
@Path("{role-id}/composites") @DELETE @Consumes("application/json") public void deleteComposites(@PathParam("role-id") String id, List<RoleRepresentation> roles) Remove a set of roles from the role's composite- Parameters:
id
- Role idroles
- A set of roles to be removed
-
getManagementPermissions
@Path("{role-id}/management/permissions") @GET @Produces("application/json") public ManagementPermissionReference getManagementPermissions(@PathParam("role-id") String id) Return object stating whether role Authorization permissions have been initialized or not and a reference- Parameters:
id
-- Returns:
-
toMgmtRef
public static ManagementPermissionReference toMgmtRef(RoleModel role, AdminPermissionManagement permissions) -
setManagementPermissionsEnabled
@Path("{role-id}/management/permissions") @PUT @Produces("application/json") @Consumes("application/json") public ManagementPermissionReference setManagementPermissionsEnabled(@PathParam("role-id") String id, ManagementPermissionReference ref) Return object stating whether role Authorization permissions have been initialized or not and a reference- Parameters:
id
-- Returns:
- initialized manage permissions reference
-