Package com.atlassian.jira.projectconfig.rest.project

Class RolesResource

java.lang.Object

com.atlassian.jira.projectconfig.rest.project.RolesResource

@Path("roles/{projectKey}")
@Consumes("application/json")
@Produces("application/json")
public class RolesResource
extends Object

Constructor Summary

Constructors

Constructor	Description
RolesResource(ProjectRoleService roleService, ProjectService projectService, JiraAuthenticationContext jiraAuthenticationContext, AvatarService avatarService, LoginService loginService, DateTimeFormatter dateTimeFormatter, EmailFormatter emailFormatter, ApplicationRoleManager applicationRoleManager, UserManager userManager)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addActorsToRole(String projectKey, Long roleId, Map<String,String[]> actors)	Adds actors (uses and/or group) to a project role.
jakarta.ws.rs.core.Response	getRoles(String projectKey, Long roleId, String query, int pageNumber, int pageSize)

Methods inherited from class java.lang.Object

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

Constructor Details

RolesResource

@Inject
public RolesResource(ProjectRoleService roleService,
 ProjectService projectService,
 JiraAuthenticationContext jiraAuthenticationContext,
 AvatarService avatarService,
 LoginService loginService,
 DateTimeFormatter dateTimeFormatter,
 EmailFormatter emailFormatter,
 ApplicationRoleManager applicationRoleManager,
 UserManager userManager)

Method Details

getRoles

@GET
public jakarta.ws.rs.core.Response getRoles(@PathParam("projectKey")
 String projectKey,
 @QueryParam("roleId")
 Long roleId,
 @QueryParam("query")
 String query,
 @QueryParam("pageNumber") @DefaultValue("1")
 int pageNumber,
 @QueryParam("pageSize") @DefaultValue("5")
 int pageSize)

addActorsToRole

@POST
@Path("{roleId}")
public jakarta.ws.rs.core.Response addActorsToRole(@PathParam("projectKey")
 String projectKey,
 @PathParam("roleId")
 Long roleId,
 Map<String,String[]> actors)

Adds actors (uses and/or group) to a project role.

For user actors, their user keys should be used.

Parameters:

projectKey - the project key

roleId - the project role id

actors - the actors to add to the role

Returns:

number of users and groups added to a project role