Loading

Jira Cloud connector

The Jira Cloud connector communicates with the Jira Cloud REST API v3 to search issues, retrieve project and issue details, and look up users. It uses Basic authentication (email and API token) and connects to your Atlassian site by subdomain.

You can create connectors in Stack Management > Connectors.

Jira Cloud connectors have the following configuration properties:

Subdomain
Your Atlassian subdomain (for example, your-domain for https://your-domain.atlassian.net).
Email
The email address associated with your Atlassian account.
API token
A Jira API token for authentication. Refer to Get API credentials for instructions.

You can test connectors when you create or edit the connector in Kibana.

The Jira Cloud connector has the following actions:

Search issues with JQL

Search or filter Jira issues using JQL (Jira Query Language).

  • jql (required): A JQL query string (for example, project = PROJ AND status = "In Progress").
  • maxResults (optional): Maximum number of issues to return.
  • nextPageToken (optional): Pagination token from a previous response.
Get resource

Retrieve full details of a single Jira issue or project by ID or key.

  • resourceType (required): The type of resource to retrieve. Valid values: issue, project.
  • id (required): The issue key (for example, PROJ-123) or project ID.
Get projects

List or search Jira projects.

  • query (optional): Search term to filter projects by name or key.
  • maxResults (optional): Maximum number of projects to return.
  • startAt (optional): Index of the first result for pagination.
Search users

Search for Jira users by name, username, or email.

  • query (optional): A search string matching display name, email, or username.
  • username (optional): Filter by exact username.
  • accountId (optional): Filter by exact account ID.
  • startAt (optional): Index of the first result for pagination.
  • maxResults (optional): Maximum number of users to return.
  • property (optional): A user property key to filter by.

Use the Action configuration settings to customize connector networking, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

To use the Jira Cloud connector, you need a Jira API token:

  1. Log in to your Atlassian account.
  2. Go to Security > API tokens (or open API token management directly).
  3. Select Create API token.
  4. Enter a label (for example, Kibana connector) and select Create.
  5. Copy the token and store it securely. Enter this value as the API token when configuring the connector in Kibana. The email address associated with your Atlassian account is used as the username for Basic authentication.