org.everit.atlassian.restclient.jiracloud.v3.api

Class GroupApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.GroupApi

public class GroupApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Group>	addUserToGroup(UpdateUserToGroupBean requestBody, Optional<String> groupname, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add user to group Adds a user to a group.
io.reactivex.Single<Group>	createGroup(AddGroupBean requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create group Creates a group.
io.reactivex.Single<Group>	getGroup(Optional<String> groupname, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<PageBeanUserDetails>	getUsersFromGroup(Optional<String> groupname, Optional<Boolean> includeInactiveUsers, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get users from group Returns all users in a group.
io.reactivex.Completable	removeGroup(Optional<String> groupname, Optional<String> swapGroup, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove group Deletes a group.
io.reactivex.Completable	removeUserFromGroup(Optional<String> groupname, Optional<String> username, Optional<String> accountId, 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

GroupApi

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

Method Detail

addUserToGroup

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

Add user to group

Adds a user to a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters:

requestBody -

The user to add to the group.

(required)

groupname -

The name of the group (case sensitive).

(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>

createGroup

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

Create group

Creates a group.

Permissions required: Site administration (that is, member of the site-admin group).

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>

getGroup

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

Deprecated.

Get group

This operation is deprecated, use group/member.

Returns all users in a group.

Permissions required: Administer Jira global permission.

Parameters:

groupname -

The name of the group.

(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<Boolean> includeInactiveUsers,
                                                                  Optional<Long> startAt,
                                                                  Optional<Integer> maxResults,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get users from group

Returns 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 required: Administer Jira global permission.

Parameters:

groupname -

The name of the group.

(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. The maximum is 50.

(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> swapGroup,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove group

Deletes a group.

Permissions required: Site administration (that is, member of the site-admin strategic group).

Parameters:

groupname -

The name of the group.

(optional)

swapGroup -

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.

(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(Optional<String> groupname,
                                                    Optional<String> username,
                                                    Optional<String> accountId,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove user from group

Removes a user from a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters:

groupname -

The name of the group.

(optional)

username -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

accountId -

The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

(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