jiraAssignableUserSearch

Overview

This step searches for a user by name, username or email address and assigns them to given project and/or issueKey.

Input

• queryStr - name, username or email address. (partial string are allowed)
• project - project key. Either project or issueKey is mandatory.
• issueKey - issue key. Either project or issueKey is mandatory.
• site - Optional, default: JIRA_SITE environment variable.
• failOnError - Optional. default: true.

Note: It supports all the fields that any jira instance supports including custom fields. For more information about all available input fields, please refer to the JIRA Api documentation depending on your JIRA version.

Output

• Each step generates generic output, please refer to this link for more information.
• The api response of this jira_assignable_user_search step can be reused later in your script by doing response.data.required_field_name.
• You can see some example scenarios here
• All the available fields for a jira response can be found in JIRA Api documentation depending on your JIRA version.

Note: response.data returns all the fields returned by JIRA API.

Examples:

• With default site from global variables.

  node {
    stage('JIRA') {
      def users = jiraAssignableUserSearch project: 'TEST'
      echo users.data.toString()
    }
  }
  

• withEnv to override the default site (or if there is not global site)

  node {
    stage('JIRA') {
      withEnv(['JIRA_SITE=LOCAL']) {
        def users = jiraAssignableUserSearch project: 'TEST', issueKey: 'TEST-01'
        echo users.data.toString()
      }
    }
  }
  

• Without environment variables.

    def users = jiraAssignableUserSearch  queryStr: 'jenkin', project: 'TEST', site: 'LOCAL', failOnError: true
    echo users.data.toString()