Admin Guide

Synapse-Jira Admin Guide

Configuration

Synapse-Jira requires a Jira API key. For information on how to sign up, please visit the Jira API documentation.

Setting the configuration for global use

To set-up a global Jira Cloud configuration:

> jira.config.add global_config cloud global_apikey global_hostname --username global_username
Synapse-Jira config "global_config" added

To set-up a global Jira Server configuration:

> jira.config.add global_config server global_apikey global_hostname
Synapse-Jira config "global_config" added

Creating a configuration for role-based use

Add an unscoped configuration:

> jira.config.add myunscoped cloud myapikey myorg.atlassian.net --username me@example.com --scope unscoped
Synapse-Jira config "myunscoped" added

Grant another user admin permissions to the new configuration:

> jira.config.update myunscoped --perm user visi admin
Updated Synapse-Jira config "myunscoped"

Grant a role read permissions to the new configuration:

> jira.config.update myunscoped --perm role ninjas read
Updated Synapse-Jira config "myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.jira.admin or storm.lib.inet.http.proxy permission.

When the proxy configuration is set to (false) or a URL the permission will be checked when a configuration is created/updated, and when it is used to make an HTTP request.

Permissions

Package (synapse-jira) defines the following permissions:
power-ups.jira.user              : Controls user access to Synapse-Jira. ( default: false )
power-ups.jira.admin             : Controls access to Synapse-Jira admin options. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.jira.user
Added rule power-ups.jira.user to user visi.

or:

> auth.role.addrule ninjas power-ups.jira.user
Added rule power-ups.jira.user to role ninjas.

Exported APIs

Synapse-Jira does not currently export any APIs.

Node Actions

Synapse-Jira does not currently add any node actions in Optic.