Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

As of version 5.2, the Application Links plugin only supports OAuth authentication. The Trusted Applications and Basic Access authentication types have been deprecated for some time now, and are no longer supported. 

When you first upgrade to an Atlassian server application that bundles version 5.2 (or later) of the Application Links plugin, you may need to update your application links. See the Application links version matrix. This page has detailed instructions for how to update application links.

You'll know a link needs updating if you see the 

Status
subtletrue
colourYellow
titleDEPRECATED
 lozenge on the 'Configure Application Links' page in the admin area of your application. In most cases, the link can be updated automatically.

If an application link is not working as expected, refer to the Troubleshoot application links page to correct any problems first.

Anchor
paths
paths

Choose the best update path

We recommend following the automatic update path, but you can choose the best update path for your particular application link by matching the conditions in the following table:

Update path
(click for instructions) 
Link status

The link uses Trusted Apps
or Basic Access authentication

The link also uses
OAuth authentication
You are logged in with
sysadmin permissions
on the remote application
1. Auto update (recommended)
Status
subtletrue
colourYellow
titleDEPRECATED
(tick)(error)(tick)
2. Manual update
Status
subtletrue
colourYellow
titleDEPRECATED
(tick)(error)(error)
3. Auto remove deprecated
Status
subtletrue
colourYellow
titleDEPRECATED
(tick)(tick)(tick)
4. Manually remove deprecated - newer plugin versions
Status
subtletrue
colourYellow
titleDEPRECATED
(tick)(tick)(error)
5. Manually remove deprecated - older plugin versions
Status
subtletrue
colourYellow
titleDEPRECATED
(tick)(tick)(error)

Anchor
autoUpdate
autoUpdate

Path 1: Automatic update to OAuth authentication (recommended)

We highly recommend that you update automatically. The automatic update path adds OAuth authentication to both ends of the application link, checks that the new connection is working correctly, and then disables any Trusted Applications or Basic Access authentication types on the link.

Note that you can only update an application link automatically if you are logged in to the local application using an account that also has sysadmin permissions on the remote application. If you don't have such an account, you can:

  • Obtain temporary sysadmin permissions so you can perform the update automatically
  • Find someone in your organization who does have such an account to perform the automatic update for you.
  • Follow the manual update path described on this page.
Expand
titleClick to see auto update instructions...
Panel
bgColorwhite

 

Include Page
_disable TA or BA - new UI
_disable TA or BA - new UI

That's it! You're done!

Anchor
manualUpdate
manualUpdate

Path 2: Manual update from deprecated to OAuth authentication

We highly recommend that you take advantage of the automatic update path, by obtaining temporary sysadmin permissions on the remote application for your login account. If that is not possible, then follow the manual update path described in this section.

The manual update path involves manually adding OAuth authentication to both ends of the application link, and then disabling any Trusted Applications or Basic Access authentication on the link.

Choose this path if you're logged in to the local application with an account that does not have sysadmin permissions on the remote application, and you're not able to get those sysadmin permissions.

Expand
titleClick to see manual update instructions...
Panel
bgColorwhite

Begin in the local application

First we're going to add OAuth authentication to this end of the link.

Go to the 'Configure Application Links' page in the admin area of the local application.

You'll see a

Status
subtletrue
colourYellow
titleDEPRECATED
lozenge beside links that need to be updated:

Include Page
_add OAuth - new UI
_add OAuth - new UI

Now you'll see a

Status
subtletrue
colourRed
titleCONFIG ERROR
lozenge for the link. Don't worry, we'll fix that shortly!

Now, in the remote application

We're going to add OAuth authentication to the 'remote' end of the link. Choose the instructions column here that matches the UI you see (they both achieve the same result):

Section
Column
Panel
bgColorwhite

For applications with Application Links version 5.2 or later:

Go to the 'Configure Application Links' page in the admin area of the remote application: 

Include Page
_add OAuth - new UI
_add OAuth - new UI

Column
Panel
bgColorwhite

For applications with versions of the Application Links plugin earlier than 5.2:

Go to the 'Configure Application Links' page in the admin area of the application:

Include Page
_add OAuth - old UI
_add OAuth - old UI

Close the dialog.

Once you've done that you'll see a

Status
subtletrue
colourYellow
titleDEPRECATED
lozenge for the link. Believe it or not, that's actually progress!

Next, we're going to disable any Trusted Apps or Basic Access authentication while we're at the 'remote' end of the link. You're still on the 'Configure Application Links' page, right? Again, choose the instructions column here that matches the UI you see (they both achieve the same result):

Section
Column
Panel
bgColorwhite

For applications with the Application Links plugin version 5.2 or later: 

Include Page
_disable TA or BA - new UI
_disable TA or BA - new UI

Column
Panel
bgColorwhite

For applications with versions of the Application Links plugin earlier than 5.2: 

Include Page
_disable TA or BA - old UI
_disable TA or BA - old UI

Close the dialog.

Once you've done that you'll see a

Status
subtletrue
colourGreen
titleCONNECTED
lozenge for the link. Great!

Back in the local application

You'll still see a

Status
subtletrue
colourYellow
titleDEPRECATED
lozenge beside the link you're updating.

We need to remove any Trusted Apps or Basic Access authentication on the 'local' end of the link.

Include Page
_disable TA or BA - new UI
_disable TA or BA - new UI

You'll see a

Status
subtletrue
colourGreen
titleCONNECTED
lozenge for the link. You're done!


Anchor
autoRemove
autoRemove

Path 3: Automatically remove deprecated authentication so only OAuth is used

When the application link already has OAuth authentication working, updating the link simply involves removing any Trusted Applications or Basic Access authentication on the link.

The link can be updated automatically if you are logged in to the local application using an account that also has sysadmin permissions on the remote application. If you don't have such an account, you can:

  • Obtain temporary sysadmin permissions so you can perform the update automatically
  • Find someone in your organization who does have such an account to perform the automatic update for you.
  • Follow the manual update path described on this page.
Expand
titleClick to see auto removal instructions...
Panel
bgColorwhite

Include Page
_disable TA or BA - new UI
_disable TA or BA - new UI

That's it! You're done!

Anchor
manualRemove
manualRemove

Path 4: Manually remove deprecated authentication when using newer versions

For applications with the Application Links plugin version 5.2 or later.

When the application link already has OAuth authentication working, updating the link simply involves removing any Trusted Applications or Basic Access authentication on both ends of the link.

We highly recommend that you take advantage of the automatic update path, by obtaining temporary sysadmin permissions on the remote application for your login account. If that isn't possible, then follow the manual update path described in this section.

Expand
titleClick to see manual removal instructions...
Panel
bgColorwhite

Begin in the local application

Go to the 'Configure Application Links' page in the admin area of the local application.

Include Page
_disable TA or BA - new UI
_disable TA or BA - new UI

You'll see this warning:

so make sure you also remove the deprecated authentication types from the remote application, described next.

Now, in the remote application

Again, go to the 'Configure Application Links' page in the admin area of the remote application.

Include Page
_disable TA or BA - new UI
_disable TA or BA - new UI

Anchor
manualOldEditRemove
manualOldEditRemove

Path 5: Manually remove deprecated authentication when using older versions

For applications with versions of the Application Links plugin earlier than 5.2.

When the application link already has OAuth authentication working, updating the link simply involves removing any Trusted Applications or Basic Access authentication on the remote end of the link.

We highly recommend that you take advantage of the automatic update path, by obtaining temporary sysadmin permissions on the remote application for your login account. If that is not possible, then follow the manual update path described in this section.

Expand
titleClick to see manual removal instructions...
Panel
bgColorwhite

Begin in the local application

Go to the 'Configure Application Links' page in the admin area of the local application.

Include Page
_disable TA or BA - old UI
_disable TA or BA - old UI

Close the dialog.

Now, in the remote application

Again, go to the 'Configure Application Links' page in the admin area of the local application.

Include Page
_disable TA or BA - old UI
_disable TA or BA - old UI

Close the dialog. You're done!