Authentication options
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
|
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. | |
Slack | 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 using personal access tokens - actions like
renderRequest
or actions that use similar support under the covers depending on action parameters used. In this case, you receive an error message such as:Client error: Action or capability not available when using token authentication. Use user and password parameters instead.
Sometimes, you can avoid restricted capabilities by adjusting the parameters you use on the action. Otherwise, you need to revert to the standard user and password support. - If secure administrator sessions (websudo) are turned on for your instance and you attempt a secure administration action, websudo permission errors occur. Turn off the websudo for your site or revert to the standard user and password support.
Log a request with our support team.
Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.