Package Documentation
Storm Package: synapse-jira
The following Commands are available from this package. This documentation is generated for version 3.0.0 of the package.
Storm Commands
This package implements the following Storm Commands.
jira.config.add
Add a Synapse-Jira configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add a global cloud configuration
jira.config.add global_config cloud apikey1234 myorg.atlassian.net --username me@example.com
// Add a global server configuration
jira.config.add global_config server apikey1234 jira.example.com
// Add a server configuration for the current user
jira.config.add --scope self my_config server apikey5678 jira.example.com
Usage: jira.config.add [options] <name> <server_type> <apikey> <hostname>
Options:
--help : Display the command usage.
--username <username> : The Jira username. Only required for Jira cloud servers.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Jira. (default: rep.jira)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
<server_type> : The Jira server type. (choices: cloud, server)
<apikey> : The API key string.
<hostname> : The Jira hostname to connect to.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.config.del
Delete a Synapse-Jira configuration.
Examples:
// Delete the "fooconfig" configuration
jira.config.del fooconfig
Usage: jira.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.config.list
Display the list of Synapse-Jira configurations you have access to.
Usage: jira.config.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.config.migrate
Migrate options for all Synapse-Jira configurations.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Migrate the tag prefix for all configurations
jira.config.migrate --tag-prefix my.tagpref
Usage: jira.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Jira. (default: None)
--hostname <hostname> : The hostname to use when connecting to Jira. (default: None)
The command is accessible to users with one or more of the following permissions:
power-ups.jira.admin
jira.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
jira.config.show
// Show a configuration by name
jira.config.show myconfig
Usage: jira.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.config.update
Update the configuration of a defined Synapse-Jira configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the permission level for user "myuser" to "admin" on the "fooconfig"
// configuration
jira.config.update fooconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "fooconfig" configuration
jira.config.update fooconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "fooconfig"
jira.config.update fooconfig --ssl-verify (false)
// Change the name of the "fooconfig" configuration to "barconfig"
jira.config.update fooconfig --name barconfig
Usage: jira.config.update [options] <config>
Options:
--help : Display the command usage.
--apikey <apikey> : The API key string. (default: None)
--perm <perm> : Set the permission level for a user or role on this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level, or None to remove the permission.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Jira. (default: None)
--hostname <hostname> : The hostname to use when connecting to Jira. (default: None)
--name <name> : Rename the configuration. (default: None)
Arguments:
<config> : The name of the configuration to modify.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.issue.byid
Retrieve a Jira issue by it's ID.
By default this command will create a proj:ticket node, as well as
proj:project and proj:comment nodes, from the requested Jira issue. If the
--dry-run argument is provided the command will only print out the issues.
Example:
// Retrieve Jira issue TEST-1
jira.issue.byid TEST-1
// Retrieve Jira issue TEST-1 and only display the results
jira.issue.byid TEST-1 --dry-run
Endpoints:
/rest/api/3/issue/{key} : Returns the details for an issue.
/rest/api/2/issue/{key} : Returns a full representation of the issue for the given issue key.
Usage: jira.issue.byid [options] <id>
Options:
--help : Display the command usage.
--dry-run : Only display the result and do not create nodes.
--no-tags : Construct nodes but do not record tags returned by the Jira API.
--yield : Yield the newly created proj:ticket node.
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
Arguments:
<id> : The Jira issue ID to retrieve.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.issue.create
Create a simple JIRA issue.
This command requires a project identifier, issue type, and summary to create a
new issue.
The jira.issue.types command can be used to determine the available issue types
which can be used for the project specified.
Additional fields may be specified by providing a dictionary with the field names
and values to the --fields argument of this command.
Example:
// Create an issue of type "Bug" in the project "MDR"
jira.issue.create MDR Bug "As: User Want: More data So: Analysis"
Endpoints:
/rest/api/3/project/{key} : Returns the project details for a project.
/rest/api/3/issue : Creates an issue.
/rest/api/2/project/{key} : Returns a full representation of a project in JSON format.
/rest/api/2/issue : Creates an issue.
Usage: jira.issue.create [options] <project> <type> <summary>
Options:
--help : Display the command usage.
--fields <fields> : Extra fields to add when creating the issue (default: None)
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
Arguments:
<project> : Jira project to create the issue in.
<type> : Type of issue to create.
<summary> : Title of the issue.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.issue.search
Search for Jira issues using a JQL query.
By default this command will create proj:ticket nodes, as well as proj:project
and proj:comment nodes, from the results returned by the submitted JQL query.
If the --dry-run argument is provided the command will only print out the issues.
Example:
// Search for issues in project "MDR" with priority "Highest"
// and create nodes from the results
jira.issue.search 'project = "MDR" and priority="Highest"'
// Search for issues in project "MDR" with priority "Highest"
// and yield proj:ticket nodes
jira.issue.search 'project = "MDR" and priority="Highest"' --yield
// Create nodes without applying Jira labels as tags
jira.issue.search 'project = "MDR" and priority="Highest"' --no-tags
// Search for issues in project "MDR" with priority "Highest"
// and only display the results
jira.issue.search 'project = "MDR" and priority="Highest"' --dry-run
Endpoints:
/rest/api/3/search/jql : Searches for issues using JQL.
/rest/api/2/search : Searches for issues using JQL.
Usage: jira.issue.search [options] <query>
Options:
--help : Display the command usage.
--size <size> : Maximum number of issues to return. (default: 100)
--dry-run : Only display the results and do not create nodes.
--no-tags : Construct nodes but do not record tags returned by the Jira API.
--yield : Yield the newly created proj:ticket nodes.
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
Arguments:
<query> : The JQL query to submit.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.issue.transition
Change the status of a JIRA issue.
The jira.issue.transition.options command can be used to determine the
available target transition options for an issue.
Example:
// Change the status of issue "MDR-8" to "pending"
jira.issue.transition "MDR-8" "pending"
Endpoints:
/rest/api/3/issue/{key}/transitions: Get valid transitions or perform a transition on an issue.
/rest/api/2/issue/{key}/transitions: Get valid transitions or perform a transition on an issue.
Usage: jira.issue.transition [options] <issue> <target>
Options:
--help : Display the command usage.
--fields <fields> : Extra fields to add when transitioning the issue (default: None)
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
Arguments:
<issue> : Jira issue to transition.
<target> : Status to transition the issue to.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.issue.transition.options
Get the available transition options for a given issue.
The output from this command displays the available target transition options
for an issue which can be provided to the jira.issue.transition command.
Example:
// Get the available transition options for issue "MDR-8"
jira.issue.transition.options "MDR-8"
Endpoints:
/rest/api/3/issue/{key}/transitions: Get valid transitions or perform a transition on an issue.
/rest/api/2/issue/{key}/transitions: Get valid transitions or perform a transition on an issue.
Usage: jira.issue.transition.options [options] <issue>
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
Arguments:
<issue> : Jira issue to transition.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.issue.types
List the available issue types for a project.
The output from this command displays the available issue types which can
be provided when creating an issue using the jira.issue.create command.
Example:
// List the available issue types in the project "MDR"
jira.issue.types MDR
Endpoints:
/rest/api/3/project/{key} : Returns the project details for a project.
/rest/api/3/issuetype/project: Returns issue types for a project.
/rest/api/2/project/{key} : Returns a full representation of a project in JSON format.
/rest/api/2/issuetype/page : Get paginated list of filtered issue types.
Usage: jira.issue.types [options] <project>
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
Arguments:
<project> : Jira project to list issue types for.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
jira.users
Display the list of Jira users.
Endpoints:
/rest/api/3/users : Returns a list of all users, including active users, inactive users, and previously
deleted users that have an Atlassian account.
/rest/api/2/user/assignable/multiProjectSearch: Returns a list of users that can be assigned issues for a given project.
Usage: jira.users [options]
Options:
--help : Display the command usage.
--project <project> : The Jira project to query (only required for Jira Server). (default: None)
--size <size> : Maximum number of users to return. (default: 100)
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
The command is accessible to users with one or more of the following permissions:
power-ups.jira.adminpower-ups.jira.user
Storm Modules
This package does not export any Storm APIs.