Home Reference Source Repository

Typedef

Static Public Summary
public	JiraApiOptions: *
public	OAuth: *
public	SearchUserOptions: *
public	UriOptions: object
public	makeRequestHeaderOptions: *
public	makeSprintQueryUriOptions: *
public	makeUriOptions: *
public	makeWebhookUriOptions: *

Static Public

public JiraApiOptions: * source

Properties:

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	What port is this tool connecting to jira with? Only needed for none standard ports. 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. Cloud users need to generate an API token for this value.
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?
intermediatePath	string	optional	If specified, overwrites the default rest/api/version section of the uri
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
timeout	number	optional	Integer containing the number of milliseconds to wait for a server to send response headers (and start the response body) before aborting the request. Note that if the underlying TCP connection cannot be established, the OS-wide TCP connection timeout will overrule the timeout option (the default in Linux can be anywhere from 20-120 * seconds).
webhookVersion	string	optional default: 1.0	What webhook version does this api wrapper need to hit?
greenhopperVersion	string	optional default: 1.0	What webhook version does this api wrapper need to hit?
ca	string	optional	Specify a CA certificate
oauth	OAuth	optional	Specify an OAuth object for this tool to authenticate all requests using OAuth.
bearer	string	optional	Specify an OAuth bearer token to authenticate all requests with.

public OAuth: * source

Properties:

Name	Type	Attribute	Description
consumer_key	string		The consumer entered in Jira Preferences.
consumer_secret	string		The private RSA file.
access_token	string		The generated access token.
access_token_secret	string		The generated access toke secret.
signature_method	string		[signature_method=RSA-SHA1] - OAuth signurate methode Possible values RSA-SHA1, HMAC-SHA1, PLAINTEXT. Jira Cloud supports only RSA-SHA1.

public SearchUserOptions: * source

Properties:

Name	Type	Attribute	Description
username	string		(DEPRECATED) A query string used to search username, name or e-mail address
query	string		A 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.
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

public UriOptions: object source

Properties:

Name	Type	Attribute	Description
pathname	string		The url after the specific functions path
query	object	optional	An object of all query parameters
intermediatePath	string	optional	Overwrites with specified path

public makeRequestHeaderOptions: * source

Properties:

Name	Type	Attribute	Description
method	string	optional	HTTP Request Method. ie GET, POST, PUT, DELETE

public makeSprintQueryUriOptions: * source

Properties:

Name	Type	Attribute	Description
pathname	string		The url after the /rest/api/version
query	object		a query object
intermediatePath	string		will overwrite the /rest/greenhopper/version section

public makeUriOptions: * source

Properties:

Name	Type	Attribute	Description
pathname	string		The url after the /rest/api/version
query	object		a query object
intermediatePath	string		If specified will overwrite the /rest/api/version section

public makeWebhookUriOptions: * source

Properties:

Name	Type	Attribute	Description
pathname	string		The url after the /rest/webhooks
intermediatePath	string		If specified will overwrite the /rest/webhooks section