Package org.apache.fineract.useradministration.api

Class RolesApiResource

java.lang.Object

org.apache.fineract.useradministration.api.RolesApiResource

@Path("/v1/roles")
@Component
public class RolesApiResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVAILABLE_PERMISSIONS
static final String	DESCRIPTION
static final String	DISABLE
static final String	ENABLE
static final String	ID
static final String	NAME
static final String	PERMISSION_USAGE_DATA
static final String	SELECTED_PERMISSIONS

Constructor Summary

Constructors

Constructor	Description
RolesApiResource()

Method Summary

Modifier and Type	Method	Description
String	actionsOnRoles(Long roleId, String commandParam, String apiRequestBodyAsJson)	Roles enable or disable
String	createRole(String apiRequestBodyAsJson)
String	deleteRole(Long roleId)	Delete Role
String	retrieveAllRoles(jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveRole(Long roleId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveRolePermissions(Long roleId, jakarta.ws.rs.core.UriInfo uriInfo)
String	updateRole(Long roleId, String apiRequestBodyAsJson)
String	updateRolePermissions(Long roleId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

AVAILABLE_PERMISSIONS

public static final String AVAILABLE_PERMISSIONS

See Also:

• Constant Field Values

SELECTED_PERMISSIONS

public static final String SELECTED_PERMISSIONS

See Also:

• Constant Field Values

PERMISSION_USAGE_DATA

public static final String PERMISSION_USAGE_DATA

See Also:

• Constant Field Values

DISABLE

public static final String DISABLE

See Also:

• Constant Field Values

ENABLE

public static final String ENABLE

See Also:

• Constant Field Values

Constructor Details

RolesApiResource

public RolesApiResource()

Method Details

retrieveAllRoles

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAllRoles(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

createRole

@POST
@Consumes("application/json")
@Produces("application/json")
public String createRole(String apiRequestBodyAsJson)

retrieveRole

@GET
@Path("{roleId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveRole(@PathParam("roleId")
 Long roleId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

actionsOnRoles

@POST
@Path("{roleId}")
@Consumes("application/json")
@Produces("application/json")
public String actionsOnRoles(@PathParam("roleId")
 Long roleId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

Roles enable or disable

Parameters:

roleId -

commandParam -

apiRequestBodyAsJson -

Returns:

updateRole

@PUT
@Path("{roleId}")
@Consumes("application/json")
@Produces("application/json")
public String updateRole(@PathParam("roleId")
 Long roleId,
 String apiRequestBodyAsJson)

retrieveRolePermissions

@GET
@Path("{roleId}/permissions")
@Consumes("application/json")
@Produces("application/json")
public String retrieveRolePermissions(@PathParam("roleId")
 Long roleId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

updateRolePermissions

@PUT
@Path("{roleId}/permissions")
@Consumes("application/json")
@Produces("application/json")
public String updateRolePermissions(@PathParam("roleId")
 Long roleId,
 String apiRequestBodyAsJson)

deleteRole

@DELETE
@Path("{roleId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteRole(@PathParam("roleId")
 Long roleId)

Delete Role

Parameters:

roleId -

Returns: