The display name of the node within the flows.

A system-wide unique identifier for this plugin instance used to locate the service.

Configuration option determining the type of operation to perform:

• Find Groups: Finds matching groups by name.
• Add User to Group: Adds a user to a group.
• Remove User from Group: Removes a user from a group.

Successful results for an action are placed in msg.payload.jira.[uniqueId].response.

The search string used to search through group names. Looks for the sub-string within existing group names.

When set, the Exclude configuration parameter, excludes specifically named groups from the matching results. This value may be a comma separated group list string or an array of groups.

The maximum number of groups to return when performing the Find Groups action.

The name of the group to add a user to or remove a user from.

The account ID for the user to be added to or removed from the designated Group.

The display name of the node within the flows.

A system-wide unique identifier for this plugin instance used to locate the service.

Configuration option determining the type of operation to perform:

• Find Issues: Retrieve issues through a Jira Query Language (JQL) search query.
• Get Issue: Retrieves an issue using an ID or key.
• Get Create Issue Metadata: Retrieves metadata to use when creating a new issue.
• Get Edit Issue Metadata: Retrieves metadata to use when editing an existing issue.
• Create Issue: Creates a new issue.
• Edit Issue: Edits an existing issue.
• Add Attachment(s): Adds attachments to an issue.
• Add Comment: Adds a comment to an issue.
• Add Watcher: Adds a watcher to an issue.

Successful results for an action are placed in msg.payload.jira.[uniqueId].response.

Defines the JQL search query. See the Advanced Searching Using JQL page for detailed documentation on the structure of the JQL search string. The search supports using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.

The issue ID or issue key uniquely identifies the Jira issue. If a value of Standard Issue Key Location is selected, the key is obtained from msg.payload.jira.[uniqueId].response.issue.key.

If specified, the Issue Fields defines the fields to return. If not specified, all fields are returned. If the field name is prefixed with a - (dash), the field is excluded from the results. This value may be a comma separated field name list or an array of fields.

If specified, the Expand Parameters defines the additional information to return. Learn more about expansion. Possible values are renderedFields, names,schema, transitions, operations, editmeta, changelog, and versionedRepresentations. This value may be a comma separated parameter list or an array of parameters.

The maximum number of issues to return when performing the Find Issues action.

Validation determines how to validate the JQL Search criteria and treat the validation results.

The Create JSON Payload configuration parameter defines the initial settings for a new issue. See the Jira API v3 Create Issue page for detailed documentation on the structure of the JSON payload. The sample payload illustrates how to create an issue with a few values defined dynamically using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.

The Edit JSON Payload configuration parameter defines the update settings to an existing issue. See the Jira API v3 Edit Issue page for detailed documentation on the structure of the JSON payload. The sample payload illustrates how to update an issue with a few values defined dynamically using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.

If Notify Users evaluates to a JavaScript truthy value, a notification is sent to all watchers of the issue by the Jira Software.

Included Attachment(s), if supplied, is a glob or extended glob pattern. Only file names matching the glob pattern are included as an attachment. For example, *.foo will include only those attachments with an extension of “foo”. *.+(jpg|gif|png) will include the three supplied file extensions of “jpg”, “gif”, and “png”. Globbing is configured to be case insensitive.

The Included Attachment(s) setting takes precedence over the Excluded Attachment(s) setting. It is recommend to define only one setting, but not both.

Excluded Attachment(s), if supplied, is also a glob or extended glob pattern. Any file attachment name matching the glob pattern is skipped from processing. For example, *.foo will exclude any attachment with an extension of “foo”. *.+(jpg|gif|png) will exclude the three supplied file extensions of “jpg”, “gif”, and “png”. Globbing is configured to be case insensitive.

The Comment field uses variable substitution from the incoming message using a mustache format. Visit the Template Engine and Formatters page to learn more.

The Watcher Id is the account ID of an existing user.

The display name of the node within the flows.

A system-wide unique identifier for this plugin instance used to locate the service.

The Path Segment defines a mustache template for the URL’s path after the API version. The following example sets the path for setting an issue’s assignee. The path for setting an issue assignee with a str context value is /issue/{{payload.issueId}}/assignee. If the payload.issueId is PROJECT-123, the final URL is [protocol]://[hostname]:[port]/rest/api/[version]/issue/PROJECT-123/assignee, where protocol, hostname, port, and version came from the plugin instance configuration.

The HTTP Method must evaluate to one of GET, POST, PUT, PATCH, or DELETE. Any other value will cause a non-recoverable failure.

When needed, the Query Parameters must evaluate to a JSON object or string. When Query Parameters evaluates to an object, the object contains the query parameters (URL parameters) as key-value pairs. Values may include any value convertible to a string. Array values will result in the same key being supplied with each element as a value within the query parameters. When Query Parameters evaluates to a string, it must contain the URL parameters in the key1=value1&key2=value2&...&keyN=valueN format. If the Query Parameters uses the {} JSON context, mustache template substitution is applied prior to generation of the final JSON object.

When needed, the Body Parameters must evaluate to a JSON object. The object contains the request payload as specified by the REST API end-point. If the Body Parameters uses the {} JSON context, mustache template substitution is applied prior to generation of the final JSON object.

The display name of the node within the flows.

A system-wide unique identifier for this plugin instance used to locate the service.

Configuration option determining the type of operation to perform:

• Find Users: Finds existing Jira users.
• Get User Groups: Retrieves the groups assigned to a user.
• Create User: Creates a new user.
• Update User: Updates an existing user.
• Delete User: Deletes an existing user.

Successful results for an action are placed in msg.payload.ipinfo.[uniqueId].response.

Performs a search of existing users’ displayName and emailAddress fields using the specified User Query. Specify an entire email address to locate an individual user.

The maximum number of users to return when performing the Find Users action.

The user’s account ID uniquely identifies the user within Jira. If the Account ID is set to Standard Account ID Location, the account ID is obtained within the standard response location at user.accountId. The location is set by a successful Find Users action.

The Create JSON Payload defines the initial user settings. See the Jira API v3 Create User page for detailed documentation on the structure of the JSON payload. The sample payload illustrates how to create a user with a few values defined dynamically using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.

The identifier for the user being updated. See the Jira API v2 Update User page for detailed documentation.

The Update JSON Payload defines the update settings. See the Jira API v2 Update User page for detailed documentation on the structure of the JSON payload. This API is documented as experimental, but has been available since July 22, 2019. The sample payload illustrates how to update a user with a few values defined dynamically using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.