org.everit.atlassian.restclient.jiracloud.v2.api

Class GroupsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.GroupsApi

public class GroupsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
GroupsApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Group>	addUserToGroup(Map<String,Object> requestBody, Optional<String> groupname, Optional<String> groupId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add user to group Adds a user to a group.
io.reactivex.Single<PageBeanGroupDetails>	bulkGetGroups(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> groupId, Optional<List<String>> groupName, Optional<String> accessType, Optional<String> applicationKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk get groups Returns a [paginated](#pagination) list of groups.
io.reactivex.Single<Group>	createGroup(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create group Creates a group.
io.reactivex.Single<FoundGroups>	findGroups(Optional<String> accountId, Optional<String> query, Optional<List<String>> exclude, Optional<List<String>> excludeId, Optional<Integer> maxResults, Optional<Boolean> caseInsensitive, Optional<String> userName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find groups Returns a list of groups whose names contain a query string.
io.reactivex.Single<Group>	getGroup(Optional<String> groupname, Optional<String> groupId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<PageBeanUserDetails>	getUsersFromGroup(Optional<String> groupname, Optional<String> groupId, Optional<Boolean> includeInactiveUsers, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get users from group Returns a [paginated](#pagination) list of all users in a group.
io.reactivex.Completable	removeGroup(Optional<String> groupname, Optional<String> groupId, Optional<String> swapGroup, Optional<String> swapGroupId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove group Deletes a group.
io.reactivex.Completable	removeUserFromGroup(String accountId, Optional<String> groupname, Optional<String> groupId, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove user from group Removes a user from a group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsApi

public GroupsApi(org.everit.http.restclient.RestClient restClient)

Method Detail

addUserToGroup

public io.reactivex.Single<Group> addUserToGroup(Map<String,Object> requestBody,
                                                 Optional<String> groupname,
                                                 Optional<String> groupId,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add user to group Adds a user to a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).

Parameters:

requestBody - The user to add to the group. (required)

groupname - As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This parameter cannot be used with the `groupId` parameter. (optional)

groupId - The ID of the group. This parameter cannot be used with the `groupName` parameter. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Group>

bulkGetGroups

public io.reactivex.Single<PageBeanGroupDetails> bulkGetGroups(Optional<Long> startAt,
                                                               Optional<Integer> maxResults,
                                                               Optional<List<String>> groupId,
                                                               Optional<List<String>> groupName,
                                                               Optional<String> accessType,
                                                               Optional<String> applicationKey,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk get groups Returns a [paginated](#pagination) list of groups. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 50)

groupId - The ID of a group. To specify multiple IDs, pass multiple `groupId` parameters. For example, `groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5`. (optional, default to new ArrayList<>())

groupName - The name of a group. To specify multiple names, pass multiple `groupName` parameters. For example, `groupName=administrators&groupName=jira-software-users`. (optional, default to new ArrayList<>())

accessType - The access level of a group. Valid values: 'site-admin', 'admin', 'user'. (optional)

applicationKey - The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanGroupDetails>

createGroup

public io.reactivex.Single<Group> createGroup(Map<String,Object> requestBody,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create group Creates a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).

Parameters:

requestBody - The name of the group. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Group>

findGroups

public io.reactivex.Single<FoundGroups> findGroups(Optional<String> accountId,
                                                   Optional<String> query,
                                                   Optional<List<String>> exclude,
                                                   Optional<List<String>> excludeId,
                                                   Optional<Integer> maxResults,
                                                   Optional<Boolean> caseInsensitive,
                                                   Optional<String> userName,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find groups Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the `html` field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically *Showing X of Y matching groups*. The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Anonymous calls and calls by users without the required permission return an empty list. *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Without this permission, calls where query is not an exact match to an existing group will return an empty list.

Parameters:

accountId - This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-2-user-groups-get). (optional)

query - The string to find in group names. (optional)

exclude - As a group's name can change, use of `excludeGroupIds` is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, `exclude=group1&exclude=group2`. This parameter cannot be used with the `excludeGroupIds` parameter. (optional, default to new ArrayList<>())

excludeId - A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, `excludeId=group1-id&excludeId=group2-id`. This parameter cannot be used with the `excludeGroups` parameter. (optional, default to new ArrayList<>())

maxResults - The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property `jira.ajax.autocomplete.limit`. (optional)

caseInsensitive - Whether the search for groups should be case insensitive. (optional, default to false)

userName - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<FoundGroups>

getGroup

@Deprecated
public io.reactivex.Single<Group> getGroup(Optional<String> groupname,
                                                        Optional<String> groupId,
                                                        Optional<String> expand,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Deprecated.

Get group This operation is deprecated, use [`group/member`](#api-rest-api-2-group-member-get). Returns all users in a group. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

groupname - As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This parameter cannot be used with the `groupId` parameter. (optional)

groupId - The ID of the group. This parameter cannot be used with the `groupName` parameter. (optional)

expand - List of fields to expand. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Group>

getUsersFromGroup

public io.reactivex.Single<PageBeanUserDetails> getUsersFromGroup(Optional<String> groupname,
                                                                  Optional<String> groupId,
                                                                  Optional<Boolean> includeInactiveUsers,
                                                                  Optional<Long> startAt,
                                                                  Optional<Integer> maxResults,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get users from group Returns a [paginated](#pagination) list of all users in a group. Note that users are ordered by username, however the username is not returned in the results due to privacy reasons. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

groupname - As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This parameter cannot be used with the `groupId` parameter. (optional)

groupId - The ID of the group. This parameter cannot be used with the `groupName` parameter. (optional)

includeInactiveUsers - Include inactive users. (optional, default to false)

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 50)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanUserDetails>

removeGroup

public io.reactivex.Completable removeGroup(Optional<String> groupname,
                                            Optional<String> groupId,
                                            Optional<String> swapGroup,
                                            Optional<String> swapGroupId,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove group Deletes a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjL)).

Parameters:

groupname - (optional)

groupId - The ID of the group. This parameter cannot be used with the `groupname` parameter. (optional)

swapGroup - As a group's name can change, use of `swapGroupId` is recommended to identify a group. The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the `swapGroupId` parameter. (optional)

swapGroupId - The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the `swapGroup` parameter. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

removeUserFromGroup

public io.reactivex.Completable removeUserFromGroup(String accountId,
                                                    Optional<String> groupname,
                                                    Optional<String> groupId,
                                                    Optional<String> username,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove user from group Removes a user from a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).

Parameters:

accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (required)

groupname - As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This parameter cannot be used with the `groupId` parameter. (optional)

groupId - The ID of the group. This parameter cannot be used with the `groupName` parameter. (optional)

username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable