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

Class UserSearchApi

java.lang.Object

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

public class UserSearchApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<User>>	findAssignableUsers(Optional<String> query, Optional<String> sessionId, Optional<String> username, Optional<String> accountId, Optional<String> project, Optional<String> issueKey, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<Integer> actionDescriptorId, Optional<Boolean> recommend, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users assignable to issues Returns a list of users that can be assigned to an issue.
io.reactivex.Single<List<User>>	findBulkAssignableUsers(String projectKeys, Optional<String> query, Optional<String> username, Optional<String> accountId, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users assignable to projects Returns a list of users who can be assigned issues in one or more projects.
io.reactivex.Single<PageBeanUserKey>	findUserKeysByQuery(String query, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find user keys by query Finds users with a structured query and returns a [paginated](#pagination) list of user keys.
io.reactivex.Single<List<User>>	findUsers(Optional<String> query, Optional<String> username, Optional<String> accountId, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<String> property, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users Returns a list of users that match the search string and property.
io.reactivex.Single<PageBeanUser>	findUsersByQuery(String query, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users by query Finds users with a structured query and returns a [paginated](#pagination) list of user details.
io.reactivex.Single<FoundUsers>	findUsersForPicker(String query, Optional<Integer> maxResults, Optional<Boolean> showAvatar, Optional<List<String>> exclude, Optional<List<String>> excludeAccountIds, Optional<String> avatarSize, Optional<Boolean> excludeConnectUsers, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users for picker Returns a list of users whose attributes match the query term.
io.reactivex.Single<List<User>>	findUsersWithAllPermissions(String permissions, Optional<String> query, Optional<String> username, Optional<String> accountId, Optional<String> issueKey, Optional<String> projectKey, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users with permissions Returns a list of users who fulfill these criteria: * their user attributes match a search string
io.reactivex.Single<List<User>>	findUsersWithBrowsePermission(Optional<String> query, Optional<String> username, Optional<String> accountId, Optional<String> issueKey, Optional<String> projectKey, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users with browse permission Returns a list of users who fulfill these criteria: * their user attributes match a search string

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSearchApi

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

Method Detail

findAssignableUsers

public io.reactivex.Single<List<User>> findAssignableUsers(Optional<String> query,
                                                           Optional<String> sessionId,
                                                           Optional<String> username,
                                                           Optional<String> accountId,
                                                           Optional<String> project,
                                                           Optional<String> issueKey,
                                                           Optional<Integer> startAt,
                                                           Optional<Integer> maxResults,
                                                           Optional<Integer> actionDescriptorId,
                                                           Optional<Boolean> recommend,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users assignable to issues Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to: * a new issue, by providing the `projectKeyOrId`. * an updated issue, by providing the `issueKey`. * to an issue during a transition (workflow action), by providing the `issueKey` and the transition id in `actionDescriptorId`. You can obtain the IDs of an issue's valid transitions using the `transitions` option in the `expand` parameter of [ Get issue](#api-rest-api-2-issue-issueIdOrKey-get). In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who can be assigned the issue, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

query - A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `username` or `accountId` is specified. (optional)

sessionId - The sessionId of this request. SessionId is the same until the assignee is set. (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)

accountId - A query string that is matched exactly against user `accountId`. Required, unless `query` is specified. (optional)

project - The project ID or project key (case sensitive). Required, unless `issueKey` is specified. (optional)

issueKey - The key of the issue. Required, unless `project` is specified. (optional)

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

maxResults - The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue. (optional, default to 50)

actionDescriptorId - The ID of the transition. (optional)

recommend - (optional, default to false)

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

findBulkAssignableUsers

public io.reactivex.Single<List<User>> findBulkAssignableUsers(String projectKeys,
                                                               Optional<String> query,
                                                               Optional<String> username,
                                                               Optional<String> accountId,
                                                               Optional<Integer> startAt,
                                                               Optional<Integer> maxResults,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users assignable to projects Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who can be assigned issues in the projects, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

Parameters:

projectKeys - A list of project keys (case sensitive). This parameter accepts a comma-separated list. (required)

query - A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` is specified. (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)

accountId - A query string that is matched exactly against user `accountId`. Required, unless `query` is specified. (optional)

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

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

findUserKeysByQuery

public io.reactivex.Single<PageBeanUserKey> findUserKeysByQuery(String query,
                                                                Optional<Long> startAt,
                                                                Optional<Integer> maxResults,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find user keys by query Finds users with a structured query and returns a [paginated](#pagination) list of user keys. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the structured query, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). The query statements are: * `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*. * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*. * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*. * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*. * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*. * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*. * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*. * `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value. The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example: `is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`

Parameters:

query - The search query. (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 100)

restRequestEnhancer -

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

Returns:

Single<PageBeanUserKey>

findUsers

public io.reactivex.Single<List<User>> findUsers(Optional<String> query,
                                                 Optional<String> username,
                                                 Optional<String> accountId,
                                                 Optional<Integer> startAt,
                                                 Optional<Integer> maxResults,
                                                 Optional<String> property,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users Returns a list of users that match the search string and property. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the search string and property. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the search string and property, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results.

Parameters:

query - A query string that is matched against user attributes ( `displayName`, and `emailAddress`) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` or `property` is specified. (optional)

username - (optional)

accountId - A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified. (optional)

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

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

property - A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified. (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<User>>

findUsersByQuery

public io.reactivex.Single<PageBeanUser> findUsersByQuery(String query,
                                                          Optional<Long> startAt,
                                                          Optional<Integer> maxResults,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users by query Finds users with a structured query and returns a [paginated](#pagination) list of user details. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the structured query, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). The query statements are: * `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*. * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*. * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*. * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*. * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*. * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*. * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*. * `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value. The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example: `is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`

Parameters:

query - The search query. (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 100)

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>

findUsersForPicker

public io.reactivex.Single<FoundUsers> findUsersForPicker(String query,
                                                          Optional<Integer> maxResults,
                                                          Optional<Boolean> showAvatar,
                                                          Optional<List<String>> exclude,
                                                          Optional<List<String>> excludeAccountIds,
                                                          Optional<String> avatarSize,
                                                          Optional<Boolean> excludeConnectUsers,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users for picker Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results. This operation takes the users in the range defined by `maxResults`, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the query term, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only.

Parameters:

query - A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. (required)

maxResults - The maximum number of items to return. The total number of matched users is returned in `total`. (optional, default to 50)

showAvatar - Include the URI to the user's avatar. (optional, default to false)

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

excludeAccountIds - A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`. (optional, default to new ArrayList<>())

avatarSize - (optional)

excludeConnectUsers - (optional, default to false)

restRequestEnhancer -

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

Returns:

Single<FoundUsers>

findUsersWithAllPermissions

public io.reactivex.Single<List<User>> findUsersWithAllPermissions(String permissions,
                                                                   Optional<String> query,
                                                                   Optional<String> username,
                                                                   Optional<String> accountId,
                                                                   Optional<String> issueKey,
                                                                   Optional<String> projectKey,
                                                                   Optional<Integer> startAt,
                                                                   Optional<Integer> maxResults,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users with permissions Returns a list of users who fulfill these criteria: * their user attributes match a search string. * they have a set of permissions for a project or issue. If no search string is provided, a list of all users with the permissions is returned. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the search string and have permission for the project or issue, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project. * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project.

Parameters:

permissions - A comma separated list of permissions. Permissions can be specified as any: * permission returned by [Get all permissions](#api-rest-api-2-permissions-get). * custom project permission added by Connect apps. * (deprecated) one of the following: * ASSIGNABLE\\_USER * ASSIGN\\_ISSUE * ATTACHMENT\\_DELETE\\_ALL * ATTACHMENT\\_DELETE\\_OWN * BROWSE * CLOSE\\_ISSUE * COMMENT\\_DELETE\\_ALL * COMMENT\\_DELETE\\_OWN * COMMENT\\_EDIT\\_ALL * COMMENT\\_EDIT\\_OWN * COMMENT\\_ISSUE * CREATE\\_ATTACHMENT * CREATE\\_ISSUE * DELETE\\_ISSUE * EDIT\\_ISSUE * LINK\\_ISSUE * MANAGE\\_WATCHER\\_LIST * MODIFY\\_REPORTER * MOVE\\_ISSUE * PROJECT\\_ADMIN * RESOLVE\\_ISSUE * SCHEDULE\\_ISSUE * SET\\_ISSUE\\_SECURITY * TRANSITION\\_ISSUE * VIEW\\_VERSION\\_CONTROL * VIEW\\_VOTERS\\_AND\\_WATCHERS * VIEW\\_WORKFLOW\\_READONLY * WORKLOG\\_DELETE\\_ALL * WORKLOG\\_DELETE\\_OWN * WORKLOG\\_EDIT\\_ALL * WORKLOG\\_EDIT\\_OWN * WORK\\_ISSUE (required)

query - A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` is specified. (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)

accountId - A query string that is matched exactly against user `accountId`. Required, unless `query` is specified. (optional)

issueKey - The issue key for the issue. (optional)

projectKey - The project key for the project (case sensitive). (optional)

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

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

findUsersWithBrowsePermission

public io.reactivex.Single<List<User>> findUsersWithBrowsePermission(Optional<String> query,
                                                                     Optional<String> username,
                                                                     Optional<String> accountId,
                                                                     Optional<String> issueKey,
                                                                     Optional<String> projectKey,
                                                                     Optional<Integer> startAt,
                                                                     Optional<Integer> maxResults,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users with browse permission Returns a list of users who fulfill these criteria: * their user attributes match a search string. * they have permission to browse issues. Use this resource to find users who can browse: * an issue, by providing the `issueKey`. * any issue in a project, by providing the `projectKey`. This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the search string and have permission to browse issues, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results.

Parameters:

query - A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` is specified. (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)

accountId - A query string that is matched exactly against user `accountId`. Required, unless `query` is specified. (optional)

issueKey - The issue key for the issue. Required, unless `projectKey` is specified. (optional)

projectKey - The project key for the project (case sensitive). Required, unless `issueKey` is specified. (optional)

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

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