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

Class UserBulkApi

java.lang.Object

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

public class UserBulkApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBeanUser>	bulkGetUsers(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> username, Optional<List<String>> key, Optional<List<String>> accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk get users Returns details of the users specified by one or more account IDs.
io.reactivex.Single<List<UserMigrationBean>>	bulkGetUsersMigration(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> username, Optional<List<String>> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get account IDs for users Returns the account IDs for the users specified in the key or username parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserBulkApi

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

Method Detail

bulkGetUsers

public io.reactivex.Single<PageBeanUser> bulkGetUsers(Optional<Long> startAt,
                                                      Optional<Integer> maxResults,
                                                      Optional<List<String>> username,
                                                      Optional<List<String>> key,
                                                      Optional<List<String>> accountId,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk get users

Returns details of the users specified by one or more account IDs.

Permissions required: Permission to access Jira.

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

(optional, default to 10)

username -

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

(optional, default to new ArrayList<>())

key -

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

(optional, default to new ArrayList<>())

accountId -

Account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e&accountId=26912:8347-325f-ef346-bd0342234324. Required.

(optional, default to new ArrayList<>())

restRequestEnhancer -

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

Returns:

Single<PageBeanUser>

bulkGetUsersMigration

public io.reactivex.Single<List<UserMigrationBean>> bulkGetUsersMigration(Optional<Long> startAt,
                                                                          Optional<Integer> maxResults,
                                                                          Optional<List<String>> username,
                                                                          Optional<List<String>> key,
                                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get account IDs for users

Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.

Permissions required: Permission to access Jira.

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 10)

username -

Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, username=fred&username=barney. Required if key isn't provided. Cannot be provided if key is present.

(optional, default to new ArrayList<>())

key -

Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, key=fred&key=barney. Required if username isn't provided. Cannot be provided if username is present.

(optional, default to new ArrayList<>())

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