Skip to main content
Server path: /jira-users | Type: Application | PCID required: Yes

Tools

ToolDescription
jira_users_find_assignable_usersFind users assignable to issues
jira_users_find_usersFind users
jira_users_find_users_and_groupsFind users and groups
jira_users_find_users_for_pickerFind users for picker
jira_users_get_bulk_permissionsGet bulk permissions
jira_users_get_current_userGet current user
jira_users_get_my_permissionsGet my permissions
jira_users_get_userGet user

jira_users_find_assignable_users

Find users assignable to issues Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoA 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.
sessionIdstringNoThe sessionId of this request. SessionId is the same until the assignee is set.
usernamestringNoThis parameter is no longer available. See the deprecation notice for details.
accountIdstringNoA query string that is matched exactly against user accountId. Required, unless query is specified.
projectstringNoThe project ID or project key (case sensitive). Required, unless issueKey or issueId is specified.
issueKeystringNoThe key of the issue. Required, unless issueId or project is specified.
issueIdstringNoThe ID of the issue. Required, unless issueKey or project is specified.
startAtintegerNoThe index of the first item to return in a page of results (page offset).
maxResultsintegerNoThe 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.
actionDescriptorIdintegerNoThe ID of the transition.
recommendbooleanNorecommend
accountTypeany[]NoaccountType
appTypeany[]NoappType

jira_users_find_users

Find users Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoA 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.
usernamestringNousername
accountIdstringNoA query string that is matched exactly against a user accountId. Required, unless query or property is specified.
startAtintegerNoThe index of the first item to return in a page of filtered results (page offset).
maxResultsintegerNoThe maximum number of items to return per page.
propertystringNoA 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.

jira_users_find_users_and_groups

Find users and groups Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesThe search string.
maxResultsintegerNoThe maximum number of items to return in each list.
showAvatarbooleanNoWhether the user avatar should be returned. If an invalid value is provided, the default value is used.
fieldIdstringNoThe custom field ID of the field this request is for.
projectIdany[]NoThe ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present.
issueTypeIdany[]NoThe ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.
avatarSizestringNoThe size of the avatar to return. If an invalid value is provided, the default value is used.
caseInsensitivebooleanNoWhether the search for groups should be case insensitive.
excludeConnectAddonsbooleanNoWhether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.

jira_users_find_users_for_picker

Find users for picker Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesA 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.
maxResultsintegerNoThe maximum number of items to return. The total number of matched users is returned in total.
showAvatarbooleanNoInclude the URI to the user’s avatar.
excludeany[]NoThis parameter is no longer available. See the deprecation notice for details.
excludeAccountIdsany[]NoA 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.
avatarSizestringNoavatarSize
excludeConnectUsersbooleanNoexcludeConnectUsers

jira_users_get_bulk_permissions

Get bulk permissions Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringNoThe account ID of a user.
globalPermissionsany[]NoGlobal permissions to look up.
projectPermissionsany[]NoProject permissions with associated projects and issues to look up.

jira_users_get_current_user

Get current user Parameters:
ParameterTypeRequiredDefaultDescription
expandstringNoUse expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * groups Returns all groups, including nested groups, the user belongs to. * applicationRoles Returns the application roles the user is assigned to.

jira_users_get_my_permissions

Get my permissions Parameters:
ParameterTypeRequiredDefaultDescription
projectKeystringNoThe key of project. Ignored if projectId is provided.
projectIdstringNoThe ID of project.
issueKeystringNoThe key of the issue. Ignored if issueId is provided.
issueIdstringNoThe ID of the issue.
permissionsstringNoA list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions.
projectUuidstringNoprojectUuid
projectConfigurationUuidstringNoprojectConfigurationUuid
commentIdstringNoThe ID of the comment.

jira_users_get_user

Get user Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringNoThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.
usernamestringNoThis parameter is no longer available. See the deprecation notice for details.
keystringNoThis parameter is no longer available. See the deprecation notice for details.
expandstringNoUse expand 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.