UserSearch

jiraUserSearch

This step searches users by name, username or email address form the JIRA SITE.

Input

• queryStr - name, username or email address. (partial string are allowed)
• site - Optional, default: JIRA_SITE environment variable.
• failOnError - Optional. default: true.

Output

• Each step generates generic output, please refer to this link for more information.
• The api response of this jira_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.

Examples

• With default site from global variables.

  node {
    stage('JIRA') {
      // where jenkins is actual username
      def users = jiraUserSearch queryStr: 'jenk'
      echo users.data.toString()
    }
  }
  

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

  node {
    stage('JIRA') {
      withEnv(['JIRA_SITE=LOCAL']) {
        // where Naresh Rayapati is actual name.
        def users = jiraUserSearch queryStr: 'Nare'
        echo users.data.toString()
      }
    }
  }
  

• Without environment variables.

  def users = jiraUserSearch queryStr: 'jenkins@thoughtslive.org', site: 'LOCAL', failOnError: true
  echo users.data.toString()