Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,369,340
Community Members
 
Community Events
168
Community Groups

How to use API token for REST calls in Python.

I'm currently intending to use the Jira API to pull data for more robust reporting. I am using Python 3.6, and the Python requests library.

Currently this works:

r = requests.get(jira_url_critquery, auth=('[username]','[password]'))

But I'd rather use the API token I've created. I've tried several different variations, but so far nothing has worked.

Here is an example of a url which works (with the username/password).

https://[our company account].atlassian.net/rest/api/2/search?jql=assignee=[my jira username]

 

Any thoughts?

6 answers

3 accepted

20 votes
Answer accepted

Hi Marvin, 

If you use the Jira Python library, just put the key where the password would go.

Example code (worked with the SAAS version of Jira, my user, my apikey)

#!/usr/bin/python3.6

# library modules
from jira import JIRA

user = 'me@here.com'
apikey = 'your0api0key0here'
server = 'https://SITE_NAME.atlassian.net'

options = {
'server': server
}

jira = JIRA(options, basic_auth=(user,apikey) )

ticket = 'KRP-11697'
issue = jira.issue(ticket)

summary = issue.fields.summary

print('ticket: ', ticket, summary)

Thank you for the answers, how can I get the users any sample python code to get user details who are in cloud Jira account?

Thanks. This worked perfectly.

I was struggling with outh but this solution is easier. Thank you! 

Can you authenticate for multiple servers in the same time? Something like

#!/usr/bin/python3.6

# library modules
from jira import JIRA

user = 'me@here.com'
apikey = 'your0api0key0here'
server1 = 'https://SITE_NAME1.atlassian.net'
server2 = 'https://SITE_NAME2.atlassian.net'


options = {
'server': [server1, sever2]
}

jira = JIRA(options, basic_auth=(user,apikey) )

(Obviously if the user has access to both)

Is this even possible? Or is there a workaround so it is achievable?

Like pradnya_ramtirthakar likes this

Can anyone help me out on how can I handle invalid username and password entered by the user. Thus, how can handle the calling of JIRA constructor using basic_auth but with wrong credentials ? ( not exception handling)

I confirm the solution works fine!

anunes I'm New Here Jul 13, 2022

@Rob Echlin Is it possible that the user isn't an email? I'm trying to authenticate using a an Organization Id and an API key, if not, as I assume it is because I have tried it. How does one fix this situation? https://support.atlassian.com/organization-administration/docs/manage-an-organization-with-the-admin-apis/  this was the guide used to create the API key in case it helps.

Thank you.

5 votes
Answer accepted

Standing on the shoulders of @Rob Echlin the Giant, here is my version:

import jira

jira = jira.JIRA('https://example.atlassian.net', basic_auth=('username@example.com', 'usernames_api_key'))

# print all of the project keys as an example
for project in jira.projects():
print(project.key)

Hello @John M 

it gives me this error : AttributeError: module 'jira' has no attribute 'JIRA'

 

Regards

Karim

Thanks Jhon McGehee.

As mentioned here, should note that this is for Cloud only - Server & Datacenter use a different header (yay!):
https://github.com/pycontribs/jira/issues/993

Since the Python Jira API doesn't yet support personal access tokens directly, for Jira Server & Datacenter a workaround is in this thread:  
https://github.com/pycontribs/jira/issues/989#issuecomment-772683446

TL;DR:

host = "YOUR_JIRA_URL"
pat = "YOUR_PERSONAL_ACCESS_TOKEN"

headers = JIRA.DEFAULT_OPTIONS["headers"].copy()
headers["Authorization"] = f"Bearer {pat}"
jira=JIRA(server=host, options={"headers": headers})

 

Like # people like this

Thanks @Oskar Austegard this worked for me. I have been trying to figure out the way to get the PAT working, and this was the only one that got it going. Kudos!

Like Oskar Austegard likes this

Perfect @Oskar Austegard ! Nice work.

1 vote
Answer accepted

Thank you sir. I shall give this a go.

Hi Marvin, 

If you use the Jira Python library, just put the key where the password would go.

 

Example code (worked with my server, user, apikey)

 

#!/usr/bin/python3.6

# library modules
from jira import JIRA

user = 'me@here.com'
apikey = 'your0api0key0here'
server = 'https://SITE_NAME.atlassian.net'

options = {
'server': server
}

jira = JIRA(options, basic_auth=(user,apikey) )

ticket = 'KRP-11697'
issue = jira.issue(ticket)

summary = issue.fields.summary

print('ticket: ', ticket, summary)

 

Like # people like this

Standing on the shoulders of giant Rob, here is my version:

import jira

jira = jira.JIRA('https://example.atlassian.net', basic_auth=('username@example.com', 'usernames_api_key'))

# print all of the project keys as an example
for project in jira.projects():
print(project.key)
Like Jason Fernandes likes this

Hi @Andy Heinzer

This is for the cloud, doest there is also a way for Jira Server?

 

Thanks,

Jason

Andy Heinzer Atlassian Team Jun 09, 2021

Hi @Jason Huang at the time this was originally created, Jira Server did not have these kinds of tokens.  But in Jira server you could still use the username and password to manage authentication.

Jira 8.14 and higher though, do now have personal access tokens, which function in much of the same way as REST API tokens do in Jira Cloud today.

Hi @Andy, thanks for your response.

I am trying the PAT, but encounter the websudo problem to create a user with the  python-jira package

Do you have any solution for it?

To use python requests library and token (rather than the jira python library), this works for me:

 

headers = {
        "Accept": "application/json",
        "Content-Type": "application/json",
        "Authorization": "Bearer " + token
         }
r = requests.get(url, headers=headers, verify=False)

Works for me! Thanks a lot!

1 vote
Andy Heinzer Atlassian Team Apr 05, 2019

@Rob Echlin and @John McGehee Thanks for posting your own solutions to this post.  If you could repost these as an answer, instead of a comment, we could then accept your answer for this question.  It would help other users that come across this thread to see more clearly other potential solutions.  

I could post your answers again myself, but it feels super disingenuous to claim your solution as my own, which is how it would appear if I just copy/pasted it.

Thanks

Andy

Thanks for the suggestion.
I created an answer from my comment.

Sincerely,
Rob

Like Andy Heinzer likes this

The answers above seem to rely upon the jira pthon library, which is useful but then how do you place a REST query after authentication, e.g. request = "https://xx.atlassian.net/rest/agile/1.0/sprint/L8C_1.1"

for example, the library does not return the sprint report from JIRA cloud to my knowledge, or from JIRA server.

So my question is

1. how to authenticate for the requests libary with a JIRA token.

2. How to then place a query, and catch the response.

currently my approach is failing with "{"message":"Client must be authenticated to access this resource.","status-code":401}"

 

Regards

Andrew

Andrew,
I have the following python snippet that shows how to get the token into a base64 string, and then into the headers so that it can be used with requests:
import requests
import base64

user = 'user.email'
token = 'token.here'
url = 'URL_HERE'

auth = user + ":" + token
encoded = base64.b64encode(bytes(auth, "utf-8"))
encodedAuth = encoded.decode("utf-8")

headers = {
  "Accept":"application/json",
  "Content-Type":"application/json",
  "Authorization":"Bearer " + encodedAuth
}

r = requests.get(url, headers=headers)
print(r)

 

Rafer

Like Federico Scheu likes this

Hi Rafer thanks for this solution, quite helpful in solving this jira authentication error:

basic authentication with passwords is deprecated

Suggest an answer

Log in or Sign up to answer