Jira: Add support for authentication through access token

Author: piwai

atlassian/rest_client.py

@@ -39,6 +39,7 @@ def __init__(
         url,
         username=None,
         password=None,
+        token=None,
         timeout=75,
         api_root="rest/api",
         api_version="latest",
@@ -69,6 +70,8 @@ def __init__(
             self._session = session
         if username and password:
             self._create_basic_session(username, password)
+        elif token is not None:
+            self._create_token_session(token)
         elif oauth is not None:
             self._create_oauth_session(oauth)
         elif oauth2 is not None:
@@ -87,6 +90,9 @@ def __exit__(self, *_):
     def _create_basic_session(self, username, password):
         self._session.auth = (username, password)
 
+    def _create_token_session(self, token):
+        self._update_header("Authorization", "Bearer {token}".format(token=token))
+
     def _create_kerberos_session(self, _):
         from requests_kerberos import HTTPKerberosAuth, OPTIONAL
 

docs/index.rst

@@ -152,6 +152,19 @@ Or reuse cookie file:
         url='http://localhost:8080',
         cookies=cookie_dict)
 
+Or using Personal Access Token
+:warning: valid for Jira Data center / server editions only! For Jira cloud, see below.
+
+First, `create your access token https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html`_
+Then, just provide the token to the constructor:
+
+.. code-block:: python
+
+   jira = Jira(
+       url='https://your-jira-instance.company.com',
+       token=jira_access_token
+   )
+
 To authenticate to the Atlassian Cloud APIs Jira, Confluence, ServiceDesk:
 
 .. code-block:: python