Typedef

Static Public

Name	Type	Attribute	Description
protocol	string	optional default: http	What protocol to use to connect to jira? Ex: http\|https
host	string		What host is this tool connecting to for the jira instance? Ex: jira.somehost.com
port	string	optional default: 80	What port is this tool connecting to jira with? Ex: 8080, 3000, etc
username	string	optional	Specify a username for this tool to authenticate all requests with.
password	string	optional	Specify a password for this tool to authenticate all requests with.
apiVersion	string	optional default: 2	What version of the jira rest api is the instance the tool is connecting to?
base	string	optional	What other url parts exist, if any, before the rest/api/ section?
strictSSL	boolean	optional default: true	Does this tool require each request to be authenticated? Defaults to true.
request	function	optional	What method does this tool use to make its requests? Defaults to request from request-promise

Name	Type	Attribute	Description
username	string		A query string used to search username, name or e-mail address
startAt	integer	optional default: 0	The index of the first user to return (0-based)
maxResults	integer	optional default: 50	The maximum number of users to return
includeActive	boolean	optional default: true	If true, then active users are included in the results
includeInactive	boolean	optional default: false	If true, then inactive users are included in the results