oauth-jira
v1.2.0
Published
This allows to make requests to Jira API using OAuth 1.0 and RSA-SHA1 method with a .pem certificate. This library is based on [Jira's example process](https://developer.atlassian.com/server/jira/platform/oauth/) using the package [oauth](https://github.c
Downloads
10
Readme
nodeJiraClient
This allows to make requests to Jira API using OAuth 1.0 and RSA-SHA1 method with a .pem certificate. This library is based on Jira's example process using the package oauth
To begin, you need the consumer key
and consumer secret
for the authentication process.
consumer key: represents the value defined at the step |Create an application link| from the Jira example process.
consumer secret: the relative path to the jira_private_key.pem file generated in the step |Generate an RSA public/private key pair| from the Jira example process.
to help and keep everything secure, you can create a .env file containing the following parameters to call their corresponding values in the example for this library:
JIRA_BASE_URL=
JIRA_CONSUMER_KEY=
JIRA_CONSUMER_SECRET_PATH=
where:
JIRA_CONSUMER_KEY: the consumer key of your Jira instance. This value is set in the step |Create an application link|from the Jira example process.
JIRA_CONSUMER_SECRET_PATH: the path to your .pem certificate file.
JIRA_BASE_URL: The host url of your Jira instance. e.g. https://jira101.atlassian.net .
import with
commonJS:
const jiraAuthenticator = require('oauth-jira').JiraAuthenticator;
ES module:
import { JiraAuthenticator } from 'oauth-jira';
The class JiraAuthenticator contains a property named utils
with some helper methods to make easier requests to jira.
For more details on usage, please review the example included in this package.