Package org.keycloak.admin.client.resource

Interface RolesResource

public interface RolesResource

Author:

[email protected]

Method Summary

Modifier and Type	Method	Description
void	create(RoleRepresentation roleRepresentation)
void	deleteRole(String roleName)
RoleResource	get(String roleName)
List<RoleRepresentation>	list()
List<RoleRepresentation>	list(boolean briefRepresentation)
List<RoleRepresentation>	list(Integer firstResult, Integer maxResults)	Get roles by pagination params.
List<RoleRepresentation>	list(Integer firstResult, Integer maxResults, boolean briefRepresentation)	Get roles by pagination params.
List<RoleRepresentation>	list(String search, boolean briefRepresentation)	Get roles by pagination params.
List<RoleRepresentation>	list(String search, Integer firstResult, Integer maxResults)	Get roles by pagination params.
List<RoleRepresentation>	list(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)	Get roles by pagination params.

Method Details

list

@GET
@Produces("application/json")
List<RoleRepresentation> list()

list

@GET
@Produces("application/json")
List<RoleRepresentation> list(@QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Parameters:

briefRepresentation - if false, return roles with their attributes

Returns:

A list containing all roles.

list

@GET
@Produces("application/json")
List<RoleRepresentation> list(@QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

Get roles by pagination params.

Parameters:

search - max number of occurrences

first - index of the first element

max - max number of occurrences

Returns:

A list containing the slice of all roles.

list

@GET
@Produces("application/json")
List<RoleRepresentation> list(@QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Get roles by pagination params.

Parameters:

first - index of the first element

max - max number of occurrences

briefRepresentation - if false, return roles with their attributes

Returns:

A list containing the slice of all roles.

list

@GET
@Produces("application/json")
List<RoleRepresentation> list(@QueryParam("search") @DefaultValue("")
 String search,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Get roles by pagination params.

Parameters:

search - max number of occurrences

briefRepresentation - if false, return roles with their attributes

Returns:

A list containing the slice of all roles.

list

@GET
@Produces("application/json")
List<RoleRepresentation> list(@QueryParam("search") @DefaultValue("")
 String search,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

Get roles by pagination params.

Parameters:

search - max number of occurrences

first - index of the first element

max - max number of occurrences

Returns:

A list containing the slice of all roles.

list

@GET
@Produces("application/json")
List<RoleRepresentation> list(@QueryParam("search") @DefaultValue("")
 String search,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Get roles by pagination params.

Parameters:

search - max number of occurrences

first - index of the first element

max - max number of occurrences

briefRepresentation - if false, return roles with their attributes

Returns:

A list containing the slice of all roles.

create

@POST
@Consumes("application/json")
void create(RoleRepresentation roleRepresentation)

get

@Path("{roleName}")
RoleResource get(@PathParam("roleName")
 String roleName)

deleteRole

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