How can I get an oauth2 access_token using Python

Question

For a project someone gave me this data that I have used in Postman for testing purposes:

In Postman this works perfectly.

Auth URL: https://api.example.com/oauth/access_token
Access Token URL: https://api.example.com/access_token
client ID: abcde
client secret: 12345
Token name: access_token
Grant type: Client Credentials

All I need is to get back the access token.

Once, I got the access token I can continue.

I have already tried several Python packages and some custom code, but somehow this seemingly simple task starts to create a real headache.

One exemple I tried:

import httplib
import base64
import urllib
import json

def getAuthToken():
    CLIENT_ID = "abcde"
    CLIENT_SECRET = "12345"
    TOKEN_URL = "https://api.example.com/oauth/access_token"

    conn = httplib.HTTPSConnection("api.example.com")

    url = "/oauth/access_token"

    params = {
        "grant_type": "client_credentials"
    }

    client = CLIENT_ID
    client_secret = CLIENT_SECRET

    authString = base64.encodestring('%s:%s' % (client, client_secret)).replace('\n', '')

    requestUrl = url + "?" + urllib.urlencode(params)

    headersMap = {
        "Content-Type": "application/x-www-form-urlencoded",
        "Authorization": "Basic " + authString
    }

    conn.request("POST", requestUrl, headers=headersMap)

    response = conn.getresponse()

    if response.status == 200:
        data = response.read()
        result = json.loads(data)

        return result["access_token"]

Then I have got this one:

import requests
import requests.auth

CLIENT_ID = "abcde"
CLIENT_SECRET = "12345"
TOKEN_URL = "https://api.example.com/oauth/access_token"
REDIRECT_URI = "https://www.getpostman.com/oauth2/callback"

def get_token(code):
    client_auth = requests.auth.HTTPBasicAuth(CLIENT_ID, CLIENT_SECRET)
    post_data = {"grant_type": "client_credentials",
                 "code": code,
                 "redirect_uri": REDIRECT_URI}
    response = requests.post(TOKEN_URL,
                             auth=client_auth,
                             data=post_data)
    token_json = response.json()
    return token_json["access_token"]

If this would work, what should I put into the code parameter

I really hope someone can help me out here.

Thanks in advance.

Martin Thoma · Accepted Answer · 2023-04-17 05:57:06Z

41

Before using it, you need to pip install requests

import requests


def get_access_token(url, client_id, client_secret):
    response = requests.post(
        url,
        data={"grant_type": "client_credentials"},
        auth=(client_id, client_secret),
    )
    return response.json()["access_token"]


get_access_token("https://api.example.com/access_token", "abcde", "12345")

The client_id identifies the client, the client_secret authenticates the client. You get the access_token for follow-up requests.

There are some alternative names:

client_id: "consumer key" in Salesforce
client_secret: "consumer secret" in Salesforce
access_token: oauth-token

edited Apr 17, 2023 at 5:57

answered Oct 12, 2021 at 18:06

Martin Thoma

139k174 gold badges687 silver badges1.1k bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

Jeff Bezos Over a year ago

Where did you get the url from?

Martin Thoma Over a year ago

From the API documentation against which I want to authenticate. For bad documentations, educated guesses are necessary

BassGod Over a year ago

This should be the highest voted answer, works great without having to include rauth

Levin Over a year ago

This snippet works for Salesforce client credentials "connected app". Salesforce calls it "Consumer key" and "Consumer secret" in their setup.

Martin Thoma Over a year ago

Thanks - I've added it to the answer

|

Cribber · Accepted Answer · 2022-07-19 12:06:48Z

15

I was finally able to get it done by using the rauth library (pip install rauth).

This is the code I used:

from rauth import OAuth2Service

class ExampleOAuth2Client:
    def __init__(self, client_id, client_secret):
        self.access_token = None

        self.service = OAuth2Service(
            name="foo",
            client_id=client_id,
            client_secret=client_secret,
            access_token_url="http://api.example.com/oauth/access_token",
            authorize_url="http://api.example.com/oauth/access_token",
            base_url="http://api.example.com/",
        )

        self.get_access_token()

    def get_access_token(self):
        data = {'code': 'bar',  # specific to my app
                'grant_type': 'client_credentials', # generally required! 
               }

        session = self.service.get_auth_session(data=data, decoder=json.loads)

        self.access_token = session.access_token

edited Jul 19, 2022 at 12:06

Cribber

3,0133 gold badges38 silver badges86 bronze badges

answered Apr 20, 2016 at 8:19

Johan Vergeer

5,64813 gold badges61 silver badges115 bronze badges

5 Comments

Rhyuk Over a year ago

Can you please explain your code a little bit? I can't seem to get it to work. Thanks in advance!

user1655072 Over a year ago

can someone explain what is the 'bar' under 'code'? Some random string? some kind of url?

Jamieson Rhyne Over a year ago

Is this using the rauth library?

DUDANF Over a year ago

Could you please explain your code/provide a complete answer? What library have you used? What is "bar"?

Davy Over a year ago

'code': 'bar' is specific to the application. Your application will probably not require this, or may use other parameters. If no parameters are required, you can safely leave it away

ekhumoro · Accepted Answer · 2017-12-06 01:11:43Z

2

Simply (in case of Facebook Authentication):

import requests, json

access_token = requests.get("https://graph.facebook.com/oauth/access_token?grant_type=client_credentials&client_id=your_client_id&client_secret=your_client_secret").json()["access_token"]

Or you can use rauth library.

In the docs there is an interesting example with facebook oAuth2 authentication:

from rauth import OAuth2Service

facebook = OAuth2Service(
client_id='your_client_id',
client_secret='your_client_secret',
name='facebook',
authorize_url='https://graph.facebook.com/oauth/authorize',
access_token_url='https://graph.facebook.com/oauth/access_token',
base_url='https://graph.facebook.com/')

and after open a session:

session = facebook.get_auth_session(data={'code': 'foo','redirect_uri': redirect_uri})

in the session json there is your access token

edited Dec 6, 2017 at 1:11

ekhumoro

122k23 gold badges272 silver badges400 bronze badges

answered Nov 13, 2017 at 15:40

CarloV

1321 silver badge12 bronze badges

2 Comments

liang Over a year ago

last commit for rauth library is in 2015, is this library still maintained?

EnE_ Over a year ago

I would say no. Try 'oauthlib' which seems popular enough and had a commit 9 days ago (07-Aug-2020)

Balaji G · Accepted Answer · 2022-09-30 08:33:18Z

2

You can use the below code when you don't have the client_secret.

Import these two libraries - import requests & import json

auth_server_url = "**mention_your_url**"

data = {"client_id": "**mention_your_client_id**", "grant_type": "**your_grant_type**", "username":"**your_username**", "password":"**your_password**", "scope": "**your_scope**"}

response = requests.post(auth_server_url, data=data, verify=False, allow_redirects=False)
tokens = json.loads(response.text)
print(tokens['access_token'])

answered Sep 30, 2022 at 8:33

Balaji G

562 bronze badges

Comments

JWB · Accepted Answer · 2022-12-10 14:32:47Z

I found this to work:

from oauthlib.oauth2 import BackendApplicationClient
from requests.auth import HTTPBasicAuth
from requests_oauthlib import OAuth2Session

# Set the OAuth2 provider URL and client credentials
provider_url = "https://oauth2.provider.com"
client_id = "your-client-id"
client_secret = "your-client-secret"

# Create a BackendApplicationClient object
client = BackendApplicationClient(client_id=client_id)

# Create an OAuth2Session object
oauth = OAuth2Session(client=client)

# Get the access token
token = oauth.fetch_token(
    token_url=provider_url + "/oauth2/token",
    auth=HTTPBasicAuth(client_id, client_secret)
)

# Print the access token
print(token["access_token"])

This code will create an OAuth2Session object using the oauthlib library and use it to get an access token from the OAuth2 provider. The provider URL, client ID, and client secret must be set to the correct values for your application. Once you have the access token, you can use it to authenticate API calls to the OAuth2 provider.

This is just an example and may not work with all OAuth2 providers. You may need to adjust the code and the parameters to match the specific requirements of your OAuth2 provider.

Collectives™ on Stack Overflow

How can I get an oauth2 access_token using Python

5 Answers 5

8 Comments

5 Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

8 Comments

5 Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related