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

Class UsersApi

java.lang.Object

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

public class UsersApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<User>>	getAllUsers(Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all users Returns a list of all (active and inactive) users.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersApi

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

Method Detail

getAllUsers

public io.reactivex.Single<List<User>> getAllUsers(Optional<Integer> startAt,
                                                   Optional<Integer> maxResults,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all users

Returns a list of all (active and inactive) users.

Permissions required: Browse users and groups global permission.

Parameters:

startAt -

The index of the first item to return.

(optional, default to 0)

maxResults -

The maximum number of items to return.

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