nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to use API token for REST calls in Python.

Marvin Hoffman

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?

Accepted answers

Kurt Klinner

@Marvin Hoffman

We made some pretty good experiences with the jira python package

https://jira.readthedocs.io/en/master/examples.html#oauth

http://blog.appliedinformaticsinc.com/how-to-get-authorize-and-request-access-token-for-jira/ might also be interesting

Kurt

Rob Echlin

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)

John McGehee_mnua5r

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)

All comments

Kurt Klinner

@Marvin Hoffman

We made some pretty good experiences with the jira python package

https://jira.readthedocs.io/en/master/examples.html#oauth

http://blog.appliedinformaticsinc.com/how-to-get-authorize-and-request-access-token-for-jira/ might also be interesting

Kurt

Marvin Hoffman

Thank you sir. I shall give this a go.

Rob Echlin

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)

John McGehee_mnua5r

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)

Andy Heinzer

@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

Rob Echlin

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)

Rob Echlin

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

Sincerely,
Rob

John McGehee_mnua5r

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)

Omantha Prasad

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?

Dilip Arsid

Thanks. This worked perfectly.

Dominique Boutin

Page for creating your tokens:

https://id.atlassian.com/manage/api-tokens#

karim.belhadj

Hello @John M

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

Regards

Karim

Emmanuel Mondragon_zl17cf

Thanks Jhon McGehee.

Oskar Austegard

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})

Andrew Sear

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

Colie Ryan

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)

Rafe G

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

brian.zaranyika

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

basic authentication with passwords is deprecated

Weronika Goracy

Works for me! Thanks a lot!

Sam Li_yi0l55

Not working for me. I'm using v9.4.11

Bill Sim_edrkib

There are a bunch of things that could be wrong... if you want help you need to pop in some more context... Are you running Cloud or DC? What is the error message if any? Are you using Requests (my assumption) or the JIRA module? What call are you making? Have you had any calls work? Etc...

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

cloud

api

atl-gruland