Interface JiraClientOptions

Constructor options for JiraClient.

interface JiraClientOptions {
    agileApiPath?: string;
    apiPath?: string;
    apiUrl: string;
    token: string;
    user: string;
}

Properties

agileApiPath? apiPath? apiUrl token user

Properties

OptionalagileApiPath

agileApiPath?: string

The Agile (Software) REST API path used for boards and sprints.

Default

'rest/agile/latest'

OptionalapiPath

apiPath?: string

The REST API path to prepend to every core request.

Default

'rest/api/latest'

apiUrl

apiUrl: string

The host URL of the Jira Data Center instance (e.g., https://jira.example.com)

token

token: string

The personal access token or password to authenticate with

user

user: string

The username to authenticate with

Settings

Member Visibility

On This Page

Properties