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

Class UsersApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.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<PageBeanUser>	bulkGetUsers(List<String> accountId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> username, Optional<List<String>> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk get users Returns a [paginated](#pagination) list 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.
io.reactivex.Single<User>	createUser(UserWriteBean requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create user Creates a user.
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.
io.reactivex.Single<List<User>>	getAllUsersDefault(Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all users default Returns a list of all (active and inactive) users.
io.reactivex.Single<User>	getUser(Optional<String> accountId, Optional<String> username, Optional<String> key, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user Returns a user.
io.reactivex.Single<List<ColumnItem>>	getUserDefaultColumns(Optional<String> accountId, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user default columns Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user.
io.reactivex.Single<UnrestrictedUserEmail>	getUserEmail(String accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user email Returns a user's email address.
io.reactivex.Single<UnrestrictedUserEmail>	getUserEmailBulk(List<String> accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user email bulk Returns a user's email address.
io.reactivex.Single<List<GroupName>>	getUserGroups(String accountId, Optional<String> username, Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user groups Returns the groups to which a user belongs.
io.reactivex.Completable	removeUser(String accountId, Optional<String> username, Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete user Deletes a user.
io.reactivex.Completable	resetUserColumns(Optional<String> accountId, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Reset user default columns Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default.
io.reactivex.Single<Object>	setUserColumns(Optional<String> accountId, Optional<List<String>> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set user default columns Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user.

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

bulkGetUsers

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

Bulk get users Returns a [paginated](#pagination) list of the users specified by one or more account IDs. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

accountId - The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`. (required)

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 - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) 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](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (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](#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>>

createUser

public io.reactivex.Single<User> createUser(UserWriteBean requestBody,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create user Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. The option is provided to set or generate a password for the user. When using the option to generate a password, by omitting `password` from the request, include `\"notification\": \"true\"` to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn't sent for a generated password, the user will need to be sent a reset password request from Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

requestBody - Details about the user to be created. (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<User>

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](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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

getAllUsersDefault

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

Get all users default Returns a list of all (active and inactive) users. **[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. (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>>

getUser

public io.reactivex.Single<User> getUser(Optional<String> accountId,
                                         Optional<String> username,
                                         Optional<String> key,
                                         Optional<String> expand,
                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user Returns a user. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

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

key - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details. (optional)

expand - Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * `groups` includes all groups and nested groups to which the user belongs. * `applicationRoles` includes details of all the applications to which the user has access. (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<User>

getUserDefaultColumns

public io.reactivex.Single<List<ColumnItem>> getUserDefaultColumns(Optional<String> accountId,
                                                                   Optional<String> username,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user default columns Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If `accountId` is not passed in the request, the calling user's details are returned. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user. * Permission to access Jira, to get the calling user's column details.

Parameters:

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

username - This parameter is no longer available and will be removed from the documentation soon. 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<List<ColumnItem>>

getUserEmail

public io.reactivex.Single<UnrestrictedUserEmail> getUserEmail(String accountId,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user email Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).

Parameters:

accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. (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<UnrestrictedUserEmail>

getUserEmailBulk

public io.reactivex.Single<UnrestrictedUserEmail> getUserEmailBulk(List<String> accountId,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user email bulk Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).

Parameters:

accountId - The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value). (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<UnrestrictedUserEmail>

getUserGroups

public io.reactivex.Single<List<GroupName>> getUserGroups(String accountId,
                                                          Optional<String> username,
                                                          Optional<String> key,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user groups Returns the groups to which a user belongs. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

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

key - This parameter is no longer available and will be removed from the documentation soon. 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<List<GroupName>>

removeUser

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

Delete user Deletes a user. **[Permissions](#permissions) required:** Site administration (that is, membership 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)

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

key - This parameter is no longer available and will be removed from the documentation soon. 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

resetUserColumns

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

Reset user default columns Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If `accountId` is not passed, the calling user's default columns are reset. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user's columns.

Parameters:

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

username - This parameter is no longer available and will be removed from the documentation soon. 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

setUserColumns

public io.reactivex.Single<Object> setUserColumns(Optional<String> accountId,
                                                  Optional<List<String>> requestBody,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set user default columns Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: `curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'` **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user's columns.

Parameters:

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

requestBody - The ID of a column to set. To set multiple columns, send multiple `columns` parameters. (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<Object>