UserSearchApi class
Jira Cloud platform REST API documentation
Constructors
- UserSearchApi(ApiClient _client)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
findAssignableUsers(
{String? query, String? sessionId, String? username, String? accountId, String? project, String? issueKey, int? startAt, int? maxResults, int? actionDescriptorId, bool? recommend}) → Future< List< User> > - 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:
-
findBulkAssignableUsers(
{String? query, String? username, String? accountId, required String projectKeys, int? startAt, int? maxResults}) → Future< List< User> > - 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.
-
findUserKeysByQuery(
{required String query, int? startAt, int? maxResults}) → Future< PageBeanUserKey> - Finds users with a structured query and returns a paginated list of user keys.
-
findUsers(
{String? query, String? username, String? accountId, int? startAt, int? maxResults, String? property}) → Future< List< User> > - Returns a list of users that match the search string and property.
-
findUsersByQuery(
{required String query, int? startAt, int? maxResults}) → Future< PageBeanUser> - Finds users with a structured query and returns a paginated list of user details.
-
findUsersForPicker(
{required String query, int? maxResults, bool? showAvatar, List< String> ? exclude, List<String> ? excludeAccountIds, String? avatarSize, bool? excludeConnectUsers}) → Future<FoundUsers> -
Returns a list of users whose attributes match the query term. The
returned object includes the
htmlfield 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. -
findUsersWithAllPermissions(
{String? query, String? username, String? accountId, required String permissions, String? issueKey, String? projectKey, int? startAt, int? maxResults}) → Future< List< User> > - Returns a list of users who fulfill these criteria:
-
findUsersWithBrowsePermission(
{String? query, String? username, String? accountId, String? issueKey, String? projectKey, int? startAt, int? maxResults}) → Future< List< User> > - Returns a list of users who fulfill these criteria:
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited