How to connect Python program to Sharepoint REST API using client id and secret provided

Question

How to connect Python program to Sharepoint REST API using client id and secret provided

Andre Neiva Liboreiro 11

Hi folks,
I need some orientation on how to proceed to connect my Python program to a Sharepoint REST API.
The following information was already provided to me:
I was thinking on requests and requests_ntml2 to do that but I dint see any information about the connection and how to set the parameters there.

Client Id:
Client Secret:
Title:
App Domain:
Redirect URI:

Would appreciate if you code send a code snipet.

THANKS

Andre

ZhengyuGuo 10,586 Reputation points Moderator

2020-08-31T03:43:54.05+00:00

Hi @Andre Neiva Liboreiro ,

Have you tried the Office365-REST-Python-Client 2.1.7 ? If it's helpful to this question, you could accept as answer so that it could also help others in the forum :)

Thanks
Best Regards
André Neiva Liboreiro 1 Reputation point

2020-09-03T00:37:30.517+00:00

Thanks @Jerryzy-MSFT but I already tried this package and could not see any way of using its parameters with client id and secret. It gives me a token access error.
ZhengyuGuo 10,586 Reputation points Moderator

2020-09-03T02:04:58.837+00:00

Hi @André Neiva Liboreiro ,

I have provide a code sample for your reference. Please check it.
And I suggest you could switch to the original account @Andre Neiva Liboreiro , so that it will be clear for others in the forum.
If the code demo is helpful to the question, you could also accept as answer so that it could help others in the forum :)

,
Deesha Kumar 1 Reputation point

2021-08-09T19:03:45.613+00:00

Hi @ZhengyuGuo !
I tried to execute the code that you have shared , but I am getting the following error :

ctx.execute_query()
File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/office365/runtime/client_runtime_context.py", line 121, in execute_query
self.pending_request().execute_query()
File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/office365/runtime/client_request.py", line 91, in execute_query
raise ClientRequestException(*e.args, response=e.response)
office365.runtime.client_request_exception.ClientRequestException: ('-2147024891, System.UnauthorizedAccessException', 'Access is denied. (Exception from HRESULT: 0x80070005 (E_ACCESSDENIED))', '403 Client Error: Forbidden for url: https://adobe.sharepoint.com/sites/<mySiteName>/_api/Web')

I had already done App registration (client ID and secret) from SharePoint using the following url : https://adobe.sharepoint.com/sites/<mySiteName>/_layouts/15/appregnew.aspx
Not sure if I am missing anything.

Please assist.

Thanks
Deesha

4 answers

Your answer

ZhengyuGuo 10,586 Reputation points Moderator

2020-08-31T03:43:54.05+00:00

Hi @Andre Neiva Liboreiro ,

Have you tried the Office365-REST-Python-Client 2.1.7 ? If it's helpful to this question, you could accept as answer so that it could also help others in the forum :)

Thanks
Best Regards
André Neiva Liboreiro 1 Reputation point

2020-09-03T00:37:30.517+00:00

Thanks @Jerryzy-MSFT but I already tried this package and could not see any way of using its parameters with client id and secret. It gives me a token access error.
ZhengyuGuo 10,586 Reputation points Moderator

2020-09-03T02:04:58.837+00:00

Hi @André Neiva Liboreiro ,

I have provide a code sample for your reference. Please check it.
And I suggest you could switch to the original account @Andre Neiva Liboreiro , so that it will be clear for others in the forum.
If the code demo is helpful to the question, you could also accept as answer so that it could help others in the forum :)

,
Deesha Kumar 1 Reputation point

2021-08-09T19:03:45.613+00:00

Hi @ZhengyuGuo !
I tried to execute the code that you have shared , but I am getting the following error :

ctx.execute_query()
File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/office365/runtime/client_runtime_context.py", line 121, in execute_query
self.pending_request().execute_query()
File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/office365/runtime/client_request.py", line 91, in execute_query
raise ClientRequestException(*e.args, response=e.response)
office365.runtime.client_request_exception.ClientRequestException: ('-2147024891, System.UnauthorizedAccessException', 'Access is denied. (Exception from HRESULT: 0x80070005 (E_ACCESSDENIED))', '403 Client Error: Forbidden for url: https://adobe.sharepoint.com/sites/<mySiteName>/_api/Web')

I had already done App registration (client ID and secret) from SharePoint using the following url : https://adobe.sharepoint.com/sites/<mySiteName>/_layouts/15/appregnew.aspx
Not sure if I am missing anything.

Please assist.

Thanks
Deesha

Answer 1

ZhengyuGuo 10,586 Moderator

Hi @Andre Neiva Liboreiro ,

Here is a sample to connect SharePoint Online using App Only credential:

site_url = 'https://contoso.sharepoint.com/'  
app_principal = {  
    'client_id': '--client-id-goes-here--',  
    'client_secret': '--client-secret-goes-here--',  
}  
  
context_auth = AuthenticationContext(url=site_url)  
context_auth.acquire_token_for_app(client_id=app_principal['client_id'], client_secret=app_principal['client_secret'])  
  
ctx = ClientContext(site_url, context_auth)  
web = ctx.web  
ctx.load(web)  
ctx.execute_query()  
print("Web site title: {0}".format(web.properties['Title']))

Eric 21 Reputation points

2021-01-21T08:03:41.63+00:00

Include in code:
from adal import AuthenticationContext
from office365.sharepoint.client_context import ClientContext

Then change this line to:
context_auth = AuthenticationContext(site_url)

BUT I still get this error:
AttributeError: 'AuthenticationContext' object has no attribute 'acquire_token_for_app'
Ds 1 Reputation point

2021-05-24T13:18:09.11+00:00

Hi @ @ZhengyuGuo ,

I am trying to follow your solutions. Is it possible to get the documentation or references which I can use for my further enhancements? Consider me as beginner.

All your supports will be appreciated.

Best Regards

Not Null 41

@Ds and others, you will finder a better example here:
https://stackoverflow.com/questions/53671547/python-download-files-from-sharepoint-site

First, you need an App registration (client ID and secret) from SharePoint or AAD.
This guy highlights the process from the AAD side, but doing it from SharePoint requires a few less steps (google).
https://python.plainenglish.io/all-you-need-to-know-file-handing-in-sharepoint-using-python-df43fde60813

After that, you will need this library: https://pypi.org/project/Office365-REST-Python-Client/

My script started working after I installed the library noted above.

from office365.runtime.auth.authentication_context import AuthenticationContext  
from office365.sharepoint.client_context import ClientContext  
from office365.sharepoint.files.file import File  
  
app_settings = {  
    'url': 'https://comapny.sharepoint.com/sites/spdev2/',  
    'client_id': 'aaaa-bbb-473a-a1b2-zzzzzfadfd',  
    'client_secret': 'Tteadsfdafdfasdff444gadfd=',  
}  
  
context_auth = AuthenticationContext(url=app_settings['url'])  
context_auth.acquire_token_for_app(client_id=app_settings['client_id'], client_secret=app_settings['client_secret'])  
  
ctx = ClientContext(app_settings['url'], context_auth)  
web = ctx.web  
ctx.load(web)  
ctx.execute_query()  
print("Web site title: {0}".format(web.properties['Title']))

Hope this helps!

DUTRANNOIS Alain (HR) 6 Reputation points

2021-08-09T15:25:03.577+00:00

Need to do the same but with Sharepoint On Premise.
Anybody to share a sample?
Nenka 1 Reputation point

2022-08-24T13:41:59.957+00:00

I am trying Office365-REST-Python-Client to read SharePoint online data in python using Client_ID and Client_Secret. I tried above code but I am getting connection errors. PFA of the error.

Below is the code I tried. Could you please help me here. Please suggest me where I am doing wrong.
Code::
from office365.runtime.auth.authentication_context import AuthenticationContext
from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.files.file import File

client_id="SharePoint_sitecollection_clientID"
client_secret="SharePoint_sitecollection_ClientSecret"

sp='https://companyname.sharepoint.com/sites/Site1'

context_auth = AuthenticationContext(sp)
context_auth.acquire_token_for_app(client_id=client_id, client_secret=client_secret)

ctx = ClientContext(sp, context_auth)
web = ctx.web
ctx.load(web)
ctx.execute_query()
print("Web title: {0}".format(web.properties['Title']))

Also, please let me know if there is any other easy way to read SharePoint online rest api data in python.

Thanks!!

Answer 2

ZhengyuGuo 10,586 Moderator

Hi @Andre Neiva Liboreiro ,

You can use Office365-Rest-Python-Client to consume SharePoint Rest API and it supported App-Only Credential authentication (AuthenticationContext.ctx_auth.acquire_token_for_app(client_id, client_secret)):

Office365-REST-Python-Client 2.1.7

Answer 3

Amit Singh 1

@ZhengyuGuo

The above code gives me access to the website, where by the title is displayed correctly. How would I read a password protected excel file in a folder, let's say, called "General" to make a python dataframe?

Many thanks in advance.

https://company.sharepoint.com/sites/Team/'Shared%20Documents/General/File%20Name%20Here%20v2.xlsm?web=1'

Jens Humrich 1 Reputation point

2022-09-02T08:44:08.783+00:00

That is a different question now, no?

Answer 4

Rajasekaran, Geetha 0

I used the above method - client id and client secret, I keep getting the same error message. ANy thoughts or suggestions on how to fix this...

ValueError: {"error":"invalid_client","error_description":"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app <client_id>

Share via

How to connect Python program to Sharepoint REST API using client id and secret provided

4 answers

Your answer