Avion Knowledge Base
avion.ioSign inSign up
  • 👋Introduction
  • 👉Getting started
    • What is Avion?
    • Define your product backbone
    • Scoping and prioritizing your product
    • Creating your release plan
    • Aligning the team
    • Integrating with backlog tools
  • Docs
    • 👏Core concepts
      • Projects
        • Project team
        • Migrating to projects
      • Organizations
        • Invite a member
        • Remove a member
        • Roles
        • Transfer ownership
        • Configure your path
        • Delete your organization
    • 🚀Story map
      • Story map anatomy
      • Journeys and steps
      • Stories
      • Releases
      • Attachments
      • Tags
      • Personas
      • Labels
      • Dependencies
      • Search and filter
      • Sharing
        • Restricted links
        • Public links
      • Workflow
      • Importing data
        • Import from Excel
          • XLSX import template
        • Import from StoriesOnBoard
      • Exporting data
        • Export to PDF
        • Export to image
        • Export to CSV
        • Export to Excel
      • Rich text editor
        • Keyboard shortcuts
        • Known limitations
      • Keyboard shortcuts
      • Tips
    • 🤝Integrations
      • Backlog tools
        • Set up an integration
          • Authentication
          • Project / board selection
          • Backbone syncing
          • Map story states
          • Additional syncing options
          • Importing data
        • Sync data
          • Pushing
          • Importing
          • Attachments
          • Deleting data
        • Configuration
        • Pause an integration
        • Re-authenticate
        • Remove an integration
        • Maintenance
          • Removing stale webhooks
        • FAQs and troubleshooting
        • Services
          • Jira Cloud
            • Features
            • Set up
            • Permissions required
            • Mapping options
              • Mapping fix versions
            • Epics ~ our thoughts
            • Additional data syncing
              • Mapping custom fields
                • Company-managed projects
                • Team-managed projects
            • Migrating to epic hierarchies
            • Import using JQL
            • FAQs and troubleshooting
              • Required fields
              • Verify webhooks
              • JQL import issues
              • Workflow issues
              • Ghost cards (cards with a dashed border)
              • Limitations
              • Jira Cloud or Jira Server
          • Jira Data Center (Server)
            • Features
            • Set up
              • Creating an application link
            • Permissions required
            • Mapping options
            • Additional data syncing
              • Mapping custom fields
            • Import using JQL
            • FAQs and troubleshooting
              • Required fields
              • Ghost cards (card with a dashed border)
              • Jira Cloud or Jira Server
              • JQL import issues
          • Azure DevOps
            • Features
            • Set up
            • Permissions required
            • Import using WIQL
            • FAQs and troubleshooting
              • Verify webhooks
              • No Azure DevOps accounts were found for your user
              • Problems communicating with Azure DevOps
              • Work items couldn't be imported
              • Show epics in Azure DevOps backlog
              • Import limits
          • Trello
            • Features
            • Set up
            • FAQs and troubleshooting
          • GitHub
            • Features
            • Set up
            • Permissions required
            • FAQs and troubleshooting
              • What types of GitHub Projects are supported?
          • Linear
            • Features
            • Set up
            • Permissions required
            • FAQs and troubleshooting
      • Notifications
        • Slack
          • Set up
          • Configure notification settings
          • Remove Slack
      • Design tools and media
        • Figma
        • Adobe XD
        • Axure
        • Framer X
        • Invision Web & Studio
        • YouTube & Vimeo
      • Embed Avion
        • Confluence
        • Confluence Server
        • Notion
        • Coda
    • 🔒Security
      • Single Sign-On (SSO)
        • Setup & Configure SSO
        • Azure AD
        • Google Workspace
        • Okta
        • OpenID Connect
      • Two-factor authentication (2FA)
    • ❓FAQs
      • Attachment file types
    • 💳Billing
      • Plans and pricing
      • Legacy plans
      • Free trials
      • Billing and payments
      • Change your plan
      • Cancel your plan
      • Refunds
      • Startup, student and educational discount
  • Story Mapping Guides
    • How To Story Map — A Simple Example
    • Advantages of Story Mapping
    • A Recommended Workflow
Powered by GitBook
On this page
  1. Docs
  2. Integrations
  3. Backlog tools
  4. Set up an integration

Authentication

Authentication (and authorization) is how Avion communicates with your backlog tool.

Last updated 1 year ago

Avion requires you to authenticate with the backlog tool you are using. Once authenticated, Avion will be able to make requests on your behalf. This is the foundation of the integration. We use very secure protocols for authentication.

  • Jira Cloud: OAuth 2.0 (plus an API token for )

  • Jira Data Center: OAuth 1.0a

  • Azure DevOps: OAuth 2.0

  • Trello: OAuth 1.0

  • GitHub & ZenHub: OAuth 2.0

Create a dedicated Avion user

Although it's convenient to be able to authenticate Avion using a personal account, we suggest using a dedicated Avion user for longer-term setups. This is useful for a few reasons:

  • Integrations don't break if the authenticated person leaves the company

  • You don't need to give individuals elevated permissions

  • It isolates Avion activity from personal user activity

  • It allows you to disconnect Avion's access very easily (just delete the Avion user)

To do this, get your IT administrator to create an Avion user in your backlog tool. Then, when you set up any integrations, ensure that you are logged in as the Avion user during authentication.

This might make sense to be done by an IT administrator, so credentials don't need to be shared. However, this does add a barrier when you want to integrate new story maps. Your decision will need to weigh up security against usability.

🤝
one API