Microsoft Dynamics 365 | Integration, Dataverse...

Access Dataverse using python

(5) Share

Report

Posted on by syamna

How do I access Dataverse using Python? What are the prerequisites required for connecting to Dataverse using an App service principal, Client ID, and Secret?

I have the same question (0)

All responses (6)

Answers (0)

Martin Dráb 237,987 Most Valuable Professional on at

Like (2)

Report

Dataverse comes with Web API, which could be easily used from Python. But... there is also pyDataverse project which could make things even simpler. (I have no experience with it.)

Here are OAuth libraries for Python: https://oauth.net/code/python/.

1 people found this reply helpful.

Was this reply helpful? Yes No
Vahid Ghafarpour 12,200 Super User 2025 Season 2 on at

Like (2)

Report

May this article help you

https://andyhowes.co/easily-connect-to-dataverse-microsoft-dynamics-with-python/

Was this reply helpful? Yes No
syamna 16 on at

Like (0)

Report

Hi VaHiX,
Thanks for your response,

Here it uses interactive MSAL authentication it doesn't work in my case I need service-to-service communication or automated tasks.
I tried,
app = msal.ConfidentialClientApplication(
client_id,
authority=authority_url,
client_credential=client_secret,
)
token_response = app.acquire_token_for_client(scopes=scope)

it is able to generate token but failed at below,

dataverse_url = 'https://<org-name>.crm.dynamics.com/api/data/v9.2/'
headers = {
'Authorization': f'Bearer {token}',
'OData-MaxVersion': '4.0',
'OData-Version': '4.0',
'Accept': 'application/json',
'Content-Type': 'application/json'
}
response = requests.get(f"{dataverse_url}accounts", headers=headers)

I am getting error:
requests.exceptions.ConnectionError: HTTPConnectionPool(host='<org-name>.crm.dynamics.com', port=443): Max retries exceeded with url: /api/data/v9.2/accounts (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x7f544af9a5d0>: Failed to establish a new connection: getaddrinfo failed',))

What might be the reason? Do I need to get any other permission for service-to-service communication or any other set up required here?

Was this reply helpful? Yes No
Vahid Ghafarpour 12,200 Super User 2025 Season 2 on at

Like (1)

Report

** Please don't forget to close up the thread here by Like and verify it as an answer if it was solved **

Was this reply helpful? Yes No
Suggested answer

fabipfr 13 on at

Like (0)

Report

I‘m assuming you want to work with the data from Dataverse tables.

I developed a python package for that. It leverages pandas DataFrames to handle easy data transformations, imports and exports.

https://github.com/fabipfr/DataversePython

this package became my trusty helper for migrations to Dynamics 365 since pandas lets you import and transform data from virtually anything :)

check my blog for detailed examples of the features:
https://blog.fabianpfriem.com/

hope this helps someone out there struggling with excel imports or dataflows..

I‘m assuming you want to work with the data from Dataverse tables.

I developed a python package for that. It leverages pandas DataFrames to handle easy data transformations, imports and exports.

https://github.com/fabipfr/DataversePython

this package became my trusty helper for migrations to Dynamics 365 since pandas lets you import and transform data from virtually anything :)

check my blog for detailed examples of the features:
https://blog.fabianpfriem.com/

hope this helps someone out there struggling with excel imports or dataflows..

Was this reply helpful? Yes No
Suggested answer

DAnny3211 11,397 on at

Like (0)

Report
Hi Syazma,

Great question! You can access Dataverse using Python by authenticating with an App Registration in Azure using a Client ID and Client Secret. Here's a general guide:

Prerequisites

Azure App Registration

Register an app in Azure Active Directory.

Note the Client ID, Tenant ID, and Client Secret.

Assign API permissions for Dataverse (Dynamics CRM).

Dataverse Environment URL

Typically looks like:
https://<your_org>.crm.dynamics.com

Python Libraries

Use msal for authentication and requests for API calls.

Sample Python Code

import msal

import requests

client_id = "<your_client_id>"

client_secret = "<your_client_secret>"

tenant_id = "<your_tenant_id>"

authority = f"https://login.microsoftonline.com/{tenant_id}"

scope = ["https://your_org.crm.dynamics.com/.default"]

app = msal.ConfidentialClientApplication(client_id, authority=authority, client_credential=client_secret)

token_response = app.acquire_token_for_client(scopes=scope)

access_token = token_response['access_token']

headers = {

    'Authorization': f'Bearer {access_token}',

    'Content-Type': 'application/json',

    'OData-MaxVersion': '4.0',

    'OData-Version': '4.0'

}

url = "https://your_org.crm.dynamics.com/api/data/v9.2/accounts"

response = requests.get(url, headers=headers)

print(response.json())

Let me know if this helps, and please mark the response as helpful if it answered your question 😊

Best regards!

Was this reply helpful? Yes No