com.atlassian.jira.rest.v2.issue

Class GroupResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.GroupResource

public class GroupResource
extends Object

Since:

v6.0

Constructor Summary

Constructors

Constructor and Description
GroupResource(GlobalPermissionManager permissionManager, JiraAuthenticationContext authContext, I18nHelper i18n, GroupManager groupManager, GroupService groupService, JiraBaseUrls jiraBaseUrls, SelfLinkBuilder selfLinkBuilder, com.atlassian.crowd.embedded.api.CrowdService crowdService, UserBeanFactory userBeanFactory, ResponseFactory responses)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUserToGroup(String groupName, UpdateUserToGroupBean userBean) Adds given user to a group.
javax.ws.rs.core.Response	createGroup(AddGroupBean groupBean) Creates a group by given group parameter
javax.ws.rs.core.Response	getGroup(String groupName, StringList expand) Deprecated.
javax.ws.rs.core.Response	getUsersFromGroup(String groupName, boolean includeInactiveUsers, Long startAt, Integer maxResults) This resource returns a paginated list of users who are members of the specified group and its subgroups.
javax.ws.rs.core.Response	removeGroup(String groupName, String swapGroup) Deletes a group by given group parameter.
javax.ws.rs.core.Response	removeUserFromGroup(String groupName, String username) Removes given user from a group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupResource

public GroupResource(GlobalPermissionManager permissionManager,
                     JiraAuthenticationContext authContext,
                     I18nHelper i18n,
                     GroupManager groupManager,
                     GroupService groupService,
                     JiraBaseUrls jiraBaseUrls,
                     SelfLinkBuilder selfLinkBuilder,
                     com.atlassian.crowd.embedded.api.CrowdService crowdService,
                     UserBeanFactory userBeanFactory,
                     ResponseFactory responses)

Method Detail

getGroup

@Deprecated
public javax.ws.rs.core.Response getGroup(String groupName,
                                                      StringList expand)

Deprecated.

Returns REST representation for the requested group. Allows to get list of active users belonging to the specified group and its subgroups if "users" expand option is provided. You can page through users list by using indexes in expand param. For example to get users from index 10 to index 15 use "users[10:15]" expand value. This will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.

This resource is deprecated, please use group/member API instead.

Parameters:

groupName - A name of requested group.

expand - List of fields to expand. Currently only available expand is "users".

Returns:

REST representation of a group

Since:

6.0

getUsersFromGroup

public javax.ws.rs.core.Response getUsersFromGroup(String groupName,
                                                   boolean includeInactiveUsers,
                                                   Long startAt,
                                                   Integer maxResults)

This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.

Parameters:

startAt - the index of the first user in group to return (0 based).

maxResults - the maximum number of users to return (max 50).

groupName - a name of the group for which members will be returned.

includeInactiveUsers - inactive users will be included in the response if set to true.

Returns:

a paginated list of users in the group.

createGroup

public javax.ws.rs.core.Response createGroup(AddGroupBean groupBean)

Creates a group by given group parameter

Returns REST representation for the requested group.

Parameters:

groupBean - a group to add

Returns:

REST representation of a group

Since:

6.1

removeGroup

public javax.ws.rs.core.Response removeGroup(String groupName,
                                             String swapGroup)

Deletes a group by given group parameter.

Returns no content

Parameters:

groupName - (mandatory) The name of the group to delete.

swapGroup - If you delete a group and content is restricted to that group, the content will be hidden from all users. To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.

Returns:

no content

Since:

6.1

addUserToGroup

public javax.ws.rs.core.Response addUserToGroup(String groupName,
                                                UpdateUserToGroupBean userBean)

Adds given user to a group.

Returns the current state of the group.

Parameters:

groupName - A name of requested group.

userBean - User to add to a group

Returns:

REST representation of a group

Since:

6.1

removeUserFromGroup

public javax.ws.rs.core.Response removeUserFromGroup(String groupName,
                                                     String username)

Removes given user from a group.

Returns no content

Parameters:

groupName - A name of requested group.

username - User to remove from a group

Returns:

REST representation of a group

Since:

6.1