Salto’s Jira adapter allows you to:

  • Fetch and deploy common Jira configuration data, e.g., workflows, custom fields, screens.
  • Deploy major configuration changes from Jira Sandbox to your production environment.
  • Compare environments.
  • Audit / document configuration changes such as workflow modifications.
  • Monitor specific changes of interest, e.g., permission schemes.

Authentication Instructions

In order to connect Jira to Salto:

  1. Obtain an API Token from https://id.atlassian.com/manage-profile/security/api-tokens
  2. Add a Jira service to a Salto environment, by selecting the environment --> "Settings" --> "Add New Service".
  3. In application credentials, provide:
    1. Your Atlassian Base URL (e.g. https://acme.atlassian.net/)
    2. The user email
    3. The token you created in step 1

Advanced Configuration

Masking automation headers

By default, the Jira adapter retrieves all automation objects, including authorization headers which may include a secret token. This helps seamless deployments of automations from one instance to another.

Salto can instead mask these tokens by replacing them with "<SECRET_TOKEN>" during fetches.
If the user deploys an automation with a masked authorization header, Salto will deploy this value instead of the correct token and a user notification will be shown with the recommended Jira steps to enter the right token

520520

In order to enable this masking, go into the service settings and add the following to your configuration NACL:

masking = {
  automationHeaders = [
    "Authorization",
  ]
}

Supported Types

The JIRA adapter fetches and deploys the following element types:

  • ApplicationProperties
  • ApplicationRoles
  • AttachmentSettings
  • Automations
  • Boards
  • Configuration
  • Dashboards
  • DashboardWidgets
  • Fields
  • FieldConfigurations
  • FieldsConfigurationSchemes
  • Filters
  • IssueEvent
  • IssueLinkType
  • IssueType
  • IssueLinkTypes
  • SecuritySchemes
  • IssueTypeSchemes
  • IssueTypeScreenSchemes
  • NotificationSchemes
  • Permissions
  • PermissionSchemes
  • Priorities
  • Projects
  • ProjectCategories
  • ProjectComponent
  • ProjectRoles
  • ProjectTypes
  • Resolutions
  • Screens
  • ScreenSchemes
  • SecurityLevels
  • SecuritySchemes
  • Statuses
  • StatusCategories
  • TimeTrackingProviders
  • Webhooks
  • Workflows
  • WorkflowSchemes

Known Limitations

  1. Salto can not update a Project in free accounts
  2. Salto can not create a project if it has a permissionScheme value on free accounts
    • Workaround: comment out the permissionScheme value, and if needed, assign it to the project in the UI after the deployment
  3. Deploying permission scheme does not work on free accounts
  4. The following types are not deployable:
    • Configuration
    • ApplicationRole
    • AttachmentSettings

FAQs

Does Salto support Jira Service Management (JSM) enabled instances?
  • Yes, we support Jira instances with JSM enabled.
  • Note that in some JSM enabled Jira instances, some objects can have duplicate names (such as custom fields or workflow statuses). While Salto will fetch these objects, we recommend users to rename these to unique names in order to correctly deploy relevant changes.
  • While we do fetch JSM projects, JSM specific types such as Queues and Request Types are not fetched today.
What impact does Salto have on my API limits?

Concurrency

Total Requests

What are the limits?

API Rate Limiting

API Rate Limiting


Did this page help you?