Admin Guide

Synapse-Jira Admin Guide

Configuration

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

Setting API key for global use

To set-up a global API key:

> jira.setup.apikey myapikey
Setting Synapse-Jira API key for all users.

Using per-user API keys

A user may set-up their own API key:

> jira.setup.apikey --self myapikey
Setting Synapse-Jira API key for the current user.

Setting API domain for global use

To set-up a global API domain:

> jira.setup.domain mydomain.atlassian.net
Setting Synapse-Jira API domain for all users.

Using per-user API domains

A user may set-up their own API domain:

> jira.setup.domain --self mydomain.atlassian.net
Setting Synapse-Jira API domain for the current user.

Setting API username for global use

To set-up a global API username:

> jira.setup.username [email protected]
Setting Synapse-Jira API username for all users.

Using per-user API usernames

A user may set-up their own API username:

> jira.setup.username --self [email protected]
Setting Synapse-Jira API username for the current user.

Setting a tag prefix for global use

Note: If not set, this will default to rep.jira.

> jira.setup.tagprefix my.prefix
Setting Jira tagprefix to my.prefix.

Permissions

Package (synapse-jira) defines the following permissions:
power-ups.jira.user              : Controls user access to Synapse-Jira. ( 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.

Onload Events

Synapse-Jira does not use any onload events.