Overview
Atlassian applications offer several authentication options for API access. Below are the ones currently supported by the Command Line Interface (CLI) in the latest releases.
Application | Basic Authentication | Session Authentication | OAuth and Related Tokens | Discussion |
---|---|---|---|---|
Jira, Confluence Cloud | No longer available | No longer available | Atlassian Personal Access Tokens (also known as API Tokens) Parameters
|
|
Jira Server | Parameters
| Parameters
Default with automatic login | Requires 8.14 or higher. Parameters
|
Personal Access Token Restrictions
|
Confluence Server | Parameters
| Parameters
Default with automatic login | Requires 7.9 or higher. Parameters
|
Personal Access Token Restrictions
|
Bamboo Server | Parameters
| Requires 6.10 or higher. Parameters
|
Personal Access Token Restrictions
| |
Bitbucket Server | Parameters
| Parameters
|
Personal Access Token Restrictions
| |
Bitbucket Cloud | No longer available | App passwords parameters
Access tokens (11.0 and higher) parameters
|
Bitbucket resource scoped access tokens - see Access Tokens for Bitbucket Cloud. These tokens have restricted capabilities, so should only be used for actions that can be achieved with the bounds of the specific restrictions otherwise the action will fail likely with an error like this. | |
Trello | Trello Token Parameters
|
| ||
Slack | Parameters
|
| ||
Tempo Cloud | Parameters
|
Personal Access Tokens for Server and Data Center
Personal access tokens have some good advantages in specific cases, but there are also some severe restrictions:
Personal access tokens can be created in the UI by going to your profile - see Atlassian documentation on personal access tokens.
Restrictions
- Some server remote capabilities used in various CLI actions may not support access via personal access tokens - actions like renderRequest or actions that use similar support under the covers depending on action parameters used. In this case, you will get an error message like:
In some cases, you can avoid restricted capabilities by adjusting parameters you are using on the action. Otherwise, you need to revert to the standard user and password support.Client error: Action or capability not available when using token authentication. Use user and password parameters instead.
- Secure administrator sessions (websudo) is turned on for your instance and you are attempting a secured administration action. In this case, you will get websudo permission errors. Turn off websudo for your site or revert to the standard user and password support.
Bamboo
Due to the lack of adequate REST API support in Bamboo, use of personal access tokens is much more restricted with only a few actions available (currently) that can be used with tokens: queueBuild and some list actions (getProjectList, getPlanList, and related) are available, but almost all configuration related actions will not work with token authentication.