Office365-REST-Python-Client 2.6.0__tar.gz → 2.6.1__tar.gz

{office365_rest_python_client-2.6.0 → office365_rest_python_client-2.6.1/Office365_REST_Python_Client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Office365-REST-Python-Client
-Version: 2.6.0
+Version: 2.6.1
 Summary: Microsoft 365 & Microsoft Graph Library for Python
 Home-page: https://github.com/vgrem/Office365-REST-Python-Client
 Author: Vadim Gremyachev
@@ -34,6 +34,7 @@ Requires-Dist: typing_extensions>=4.0.0
 Provides-Extra: ntlmprovider
 Requires-Dist: requests_ntlm; extra == "ntlmprovider"
 
+
 # About
 Microsoft 365 & Microsoft Graph library for Python
 
@@ -208,19 +209,18 @@ The list of examples:
   
 Refer [examples section](examples/sharepoint) for another scenarios
 
-### Support for non-standard SharePoint Online Environments
-
-  Support for non-standard SharePoint Environments is currently being implemented. Currently supported:
-  - GCC High
+### Support for Azure environments
 
-  To enable authentication to GCC High endpoints, add the `environment='GCCH'` parameter when calling the 
+  To enable authentication to specific Azure environment endpoints, add the `environment` parameter when calling the 
   `ClientContext class` with `.with_user_credentials`, `.with_client_credentials`, or `.with_credentials`
 
    Example:
    ```python
+   from office365.azure_env import AzureEnvironment
    from office365.sharepoint.client_context import ClientContext
+   from office365.runtime.auth.client_credential import ClientCredential
    client_credentials = ClientCredential('{client_id}','{client_secret}')
-   ctx = ClientContext('{url}').with_credentials(client_credentials, environment='GCCH')
+   ctx = ClientContext('{site-url}', environment=AzureEnvironment.USGovernmentHigh).with_credentials(client_credentials)
    ```
 
 # Working with Outlook API
@@ -249,26 +249,13 @@ Using [Microsoft Authentication Library (MSAL) for Python](https://pypi.org/proj
 > in the provided examples. Other forms of token acquisition can be found here: https://msal-python.readthedocs.io/en/latest/
 
 ```python
-import msal
 from office365.graph_client import GraphClient
-
-def acquire_token():
-    """
-    Acquire token via MSAL
-    """
-    authority_url = 'https://login.microsoftonline.com/{tenant_id_or_name}'
-    app = msal.ConfidentialClientApplication(
-        authority=authority_url,
-        client_id='{client_id}',
-        client_credential='{client_secret}'
-    )
-    token = app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
-    return token
-
-
-client = GraphClient(acquire_token)
-
+client = GraphClient(tenant='{tenant_name_or_id}').with_client_secret(
+    client_id='{client_id}', 
+    client_secret='{client_secret}'
+)
 ```
+Example: [with_client_secret](examples/auth/with_client_secret.py)
 
 But in terms of Microsoft Graph API authentication, another OAuth spec compliant libraries 
 such as [adal](https://github.com/AzureAD/azure-activedirectory-library-for-python) 
@@ -304,7 +291,9 @@ The example demonstrates how to send an email via [Microsoft Graph endpoint](htt
 ```python
 from office365.graph_client import GraphClient
 
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant='{tenant_name_or_id}').with_username_and_password(
+    '{client_id}', '{username}', '{password}'
+)
 
 client.me.send_mail(
     subject="Meet for lunch?",
@@ -370,7 +359,7 @@ which corresponds to [`list available drives` endpoint](https://docs.microsoft.c
 from office365.graph_client import GraphClient
 
 tenant_name = "contoso.onmicrosoft.com"
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant=tenant_name)
 drives = client.drives.get().execute_query()
 for drive in drives:
     print("Drive url: {0}".format(drive.web_url))
@@ -381,7 +370,7 @@ for drive in drives:
 
 ```python
 from office365.graph_client import GraphClient
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant="contoso.onmicrosoft.com")
 # retrieve drive properties 
 drive = client.users["{user_id_or_principal_name}"].drive.get().execute_query()
 # download files from OneDrive into local folder 
@@ -451,7 +440,9 @@ Example: Create a new page
 
 ```python
 from office365.graph_client import GraphClient
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant='{tenant_name_or_id}').with_username_and_password(
+    '{client_id}', '{username}', '{password}'
+)
 
 files = {}
 with open("./MyPage.html", 'rb') as f, \

{office365_rest_python_client-2.6.0/Office365_REST_Python_Client.egg-info → office365_rest_python_client-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Office365-REST-Python-Client
-Version: 2.6.0
+Version: 2.6.1
 Summary: Microsoft 365 & Microsoft Graph Library for Python
 Home-page: https://github.com/vgrem/Office365-REST-Python-Client
 Author: Vadim Gremyachev
@@ -34,6 +34,7 @@ Requires-Dist: typing_extensions>=4.0.0
 Provides-Extra: ntlmprovider
 Requires-Dist: requests_ntlm; extra == "ntlmprovider"
 
+
 # About
 Microsoft 365 & Microsoft Graph library for Python
 
@@ -208,19 +209,18 @@ The list of examples:
   
 Refer [examples section](examples/sharepoint) for another scenarios
 
-### Support for non-standard SharePoint Online Environments
-
-  Support for non-standard SharePoint Environments is currently being implemented. Currently supported:
-  - GCC High
+### Support for Azure environments
 
-  To enable authentication to GCC High endpoints, add the `environment='GCCH'` parameter when calling the 
+  To enable authentication to specific Azure environment endpoints, add the `environment` parameter when calling the 
   `ClientContext class` with `.with_user_credentials`, `.with_client_credentials`, or `.with_credentials`
 
    Example:
    ```python
+   from office365.azure_env import AzureEnvironment
    from office365.sharepoint.client_context import ClientContext
+   from office365.runtime.auth.client_credential import ClientCredential
    client_credentials = ClientCredential('{client_id}','{client_secret}')
-   ctx = ClientContext('{url}').with_credentials(client_credentials, environment='GCCH')
+   ctx = ClientContext('{site-url}', environment=AzureEnvironment.USGovernmentHigh).with_credentials(client_credentials)
    ```
 
 # Working with Outlook API
@@ -249,26 +249,13 @@ Using [Microsoft Authentication Library (MSAL) for Python](https://pypi.org/proj
 > in the provided examples. Other forms of token acquisition can be found here: https://msal-python.readthedocs.io/en/latest/
 
 ```python
-import msal
 from office365.graph_client import GraphClient
-
-def acquire_token():
-    """
-    Acquire token via MSAL
-    """
-    authority_url = 'https://login.microsoftonline.com/{tenant_id_or_name}'
-    app = msal.ConfidentialClientApplication(
-        authority=authority_url,
-        client_id='{client_id}',
-        client_credential='{client_secret}'
-    )
-    token = app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
-    return token
-
-
-client = GraphClient(acquire_token)
-
+client = GraphClient(tenant='{tenant_name_or_id}').with_client_secret(
+    client_id='{client_id}', 
+    client_secret='{client_secret}'
+)
 ```
+Example: [with_client_secret](examples/auth/with_client_secret.py)
 
 But in terms of Microsoft Graph API authentication, another OAuth spec compliant libraries 
 such as [adal](https://github.com/AzureAD/azure-activedirectory-library-for-python) 
@@ -304,7 +291,9 @@ The example demonstrates how to send an email via [Microsoft Graph endpoint](htt
 ```python
 from office365.graph_client import GraphClient
 
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant='{tenant_name_or_id}').with_username_and_password(
+    '{client_id}', '{username}', '{password}'
+)
 
 client.me.send_mail(
     subject="Meet for lunch?",
@@ -370,7 +359,7 @@ which corresponds to [`list available drives` endpoint](https://docs.microsoft.c
 from office365.graph_client import GraphClient
 
 tenant_name = "contoso.onmicrosoft.com"
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant=tenant_name)
 drives = client.drives.get().execute_query()
 for drive in drives:
     print("Drive url: {0}".format(drive.web_url))
@@ -381,7 +370,7 @@ for drive in drives:
 
 ```python
 from office365.graph_client import GraphClient
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant="contoso.onmicrosoft.com")
 # retrieve drive properties 
 drive = client.users["{user_id_or_principal_name}"].drive.get().execute_query()
 # download files from OneDrive into local folder 
@@ -451,7 +440,9 @@ Example: Create a new page
 
 ```python
 from office365.graph_client import GraphClient
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant='{tenant_name_or_id}').with_username_and_password(
+    '{client_id}', '{username}', '{password}'
+)
 
 files = {}
 with open("./MyPage.html", 'rb') as f, \

{office365_rest_python_client-2.6.0 → office365_rest_python_client-2.6.1}/README.md

@@ -1,3 +1,4 @@
+
 # About
 Microsoft 365 & Microsoft Graph library for Python
 
@@ -172,19 +173,18 @@ The list of examples:
   
 Refer [examples section](examples/sharepoint) for another scenarios
 
-### Support for non-standard SharePoint Online Environments
-
-  Support for non-standard SharePoint Environments is currently being implemented. Currently supported:
-  - GCC High
+### Support for Azure environments
 
-  To enable authentication to GCC High endpoints, add the `environment='GCCH'` parameter when calling the 
+  To enable authentication to specific Azure environment endpoints, add the `environment` parameter when calling the 
   `ClientContext class` with `.with_user_credentials`, `.with_client_credentials`, or `.with_credentials`
 
    Example:
    ```python
+   from office365.azure_env import AzureEnvironment
    from office365.sharepoint.client_context import ClientContext
+   from office365.runtime.auth.client_credential import ClientCredential
    client_credentials = ClientCredential('{client_id}','{client_secret}')
-   ctx = ClientContext('{url}').with_credentials(client_credentials, environment='GCCH')
+   ctx = ClientContext('{site-url}', environment=AzureEnvironment.USGovernmentHigh).with_credentials(client_credentials)
    ```
 
 # Working with Outlook API
@@ -213,26 +213,13 @@ Using [Microsoft Authentication Library (MSAL) for Python](https://pypi.org/proj
 > in the provided examples. Other forms of token acquisition can be found here: https://msal-python.readthedocs.io/en/latest/
 
 ```python
-import msal
 from office365.graph_client import GraphClient
-
-def acquire_token():
-    """
-    Acquire token via MSAL
-    """
-    authority_url = 'https://login.microsoftonline.com/{tenant_id_or_name}'
-    app = msal.ConfidentialClientApplication(
-        authority=authority_url,
-        client_id='{client_id}',
-        client_credential='{client_secret}'
-    )
-    token = app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
-    return token
-
-
-client = GraphClient(acquire_token)
-
+client = GraphClient(tenant='{tenant_name_or_id}').with_client_secret(
+    client_id='{client_id}', 
+    client_secret='{client_secret}'
+)
 ```
+Example: [with_client_secret](examples/auth/with_client_secret.py)
 
 But in terms of Microsoft Graph API authentication, another OAuth spec compliant libraries 
 such as [adal](https://github.com/AzureAD/azure-activedirectory-library-for-python) 
@@ -268,7 +255,9 @@ The example demonstrates how to send an email via [Microsoft Graph endpoint](htt
 ```python
 from office365.graph_client import GraphClient
 
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant='{tenant_name_or_id}').with_username_and_password(
+    '{client_id}', '{username}', '{password}'
+)
 
 client.me.send_mail(
     subject="Meet for lunch?",
@@ -334,7 +323,7 @@ which corresponds to [`list available drives` endpoint](https://docs.microsoft.c
 from office365.graph_client import GraphClient
 
 tenant_name = "contoso.onmicrosoft.com"
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant=tenant_name)
 drives = client.drives.get().execute_query()
 for drive in drives:
     print("Drive url: {0}".format(drive.web_url))
@@ -345,7 +334,7 @@ for drive in drives:
 
 ```python
 from office365.graph_client import GraphClient
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant="contoso.onmicrosoft.com")
 # retrieve drive properties 
 drive = client.users["{user_id_or_principal_name}"].drive.get().execute_query()
 # download files from OneDrive into local folder 
@@ -415,7 +404,9 @@ Example: Create a new page
 
 ```python
 from office365.graph_client import GraphClient
-client = GraphClient(acquire_token_func)
+client = GraphClient(tenant='{tenant_name_or_id}').with_username_and_password(
+    '{client_id}', '{username}', '{password}'
+)
 
 files = {}
 with open("./MyPage.html", 'rb') as f, \

{office365_rest_python_client-2.6.0 → office365_rest_python_client-2.6.1}/office365/runtime/auth/providers/saml_token_provider.py

@@ -17,12 +17,6 @@ from office365.runtime.auth.user_realm_info import UserRealmInfo
 office365.logger.ensure_debug_secrets()
 
 
-def resolve_base_url(url):
-    parts = url.split("://")
-    host_name = parts[1].split("/")[0]
-    return parts[0] + "://" + host_name
-
-
 def string_escape(value):
     value = value.replace("&", "&")
     value = value.replace("<", "&lt;")
@@ -37,7 +31,7 @@ def datetime_escape(value):
 
 
 class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):
-    def __init__(self, url, username, password, browser_mode, environment="commercial"):
+    def __init__(self, url, username, password, browser_mode, environment=None):
         """
         SAML Security Token Service provider (claims-based authentication)
 
@@ -46,13 +40,11 @@ class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):
         :param str password: The password
         :param bool browser_mode:
         :param str environment: The Office 365 Cloud Environment endpoint used for authentication.
-        By default, this will be set to commercial ('commercial', 'GCCH')
         """
         # Security Token Service info
-        self._sts_profile = STSProfile(resolve_base_url(url), environment)
+        self._sts_profile = STSProfile(url, environment)
         # Obtain authentication cookies, using the browser mode
         self._browser_mode = browser_mode
-        self._environment = environment
         # Last occurred error
         self.error = ""
         self._username = username
@@ -137,7 +129,7 @@ class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):
                 "password": string_escape(self._password),
                 "created": datetime_escape(self._sts_profile.created),
                 "expires": datetime_escape(self._sts_profile.expires),
-                "issuer": self._sts_profile.tokenIssuer,
+                "issuer": self._sts_profile.token_issuer,
             },
         )
 
@@ -184,13 +176,13 @@ class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):
         payload = self._prepare_request_from_template(
             "SAML.xml",
             {
-                "auth_url": self._sts_profile.authorityUrl,
+                "auth_url": self._sts_profile.site_url,
                 "username": string_escape(self._username),
                 "password": string_escape(self._password),
                 "message_id": str(uuid.uuid4()),
                 "created": datetime_escape(self._sts_profile.created),
                 "expires": datetime_escape(self._sts_profile.expires),
-                "issuer": self._sts_profile.tokenIssuer,
+                "issuer": self._sts_profile.token_issuer,
             },
         )
         logger.debug_secrets("options: %s", payload)

office365_rest_python_client-2.6.1/office365/runtime/auth/sts_profile.py

@@ -0,0 +1,55 @@
+from datetime import datetime, timedelta
+
+from office365.azure_env import AzureEnvironment
+from office365.runtime.compat import timezone, urlparse
+
+
+class STSProfile(object):
+    def __init__(self, site_url, environment=None):
+        # type: (str, str) -> None
+        self._site_url = site_url
+        self._environment = environment
+        self._created = datetime.now(tz=timezone.utc)
+        self._expires = self._created + timedelta(minutes=30)
+
+    def reset(self):
+        """Renew the expiration time."""
+        self._created = datetime.now(tz=timezone.utc)
+        self._expires = self._created + timedelta(minutes=30)
+
+    @property
+    def tenant(self):
+        return urlparse(self._site_url).netloc
+
+    @property
+    def security_token_service_url(self):
+        return "{0}/extSTS.srf".format(
+            AzureEnvironment.get_login_authority(self._environment),
+        )
+
+    @property
+    def signin_page_url(self):
+        site_info = urlparse(self._site_url)
+        return "{0}://{1}/_forms/default.aspx?wa=wsignin1.0".format(site_info.scheme, site_info.netloc)
+
+    @property
+    def user_realm_service_url(self):
+        return "{0}/GetUserRealm.srf".format(
+            AzureEnvironment.get_login_authority(self._environment),
+        )
+
+    @property
+    def token_issuer(self):
+        return "urn:federation:MicrosoftOnline"
+
+    @property
+    def created(self):
+        return self._created
+
+    @property
+    def expires(self):
+        return self._expires
+
+    @property
+    def site_url(self):
+        return self._site_url

{office365_rest_python_client-2.6.0 → office365_rest_python_client-2.6.1}/office365/sharepoint/request.py

@@ -3,6 +3,7 @@ from typing import Callable, List, Optional
 from requests import Response
 from typing_extensions import Self
 
+from office365.azure_env import AzureEnvironment
 from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.token_response import TokenResponse
@@ -14,12 +15,11 @@ from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 
 class SharePointRequest(ODataRequest):
     def __init__(
-        self, base_url, environment="commercial", allow_ntlm=False, browser_mode=False
+        self, base_url, environment=AzureEnvironment.Global, allow_ntlm=False, browser_mode=False
     ):
         """
         :param str base_url: Absolute Web or Site Url
         :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         :param bool allow_ntlm: Flag indicates whether NTLM scheme is enabled. Disabled by default
         :param bool browser_mode: Allow browser authentication
         """

{office365_rest_python_client-2.6.0 → office365_rest_python_client-2.6.1}/setup.py

@@ -9,7 +9,7 @@ with io.open("README.md", mode="r", encoding="utf-8") as fh:
 
 setup(
     name="Office365-REST-Python-Client",
-    version="2.6.0",
+    version="2.6.1",
     author="Vadim Gremyachev",
     author_email="vvgrem@gmail.com",
     maintainer="Konrad Gądek, Domenico Di Nicola",

office365_rest_python_client-2.6.0/office365/runtime/auth/sts_profile.py

@@ -1,40 +0,0 @@
-from datetime import datetime, timedelta
-
-from office365.runtime.compat import timezone, urlparse
-
-
-class STSProfile(object):
-    def __init__(self, authority_url, environment):
-        # type: (str, str) -> None
-        self.authorityUrl = authority_url
-        if environment == "GCCH":
-            self.serviceUrl = "https://login.microsoftonline.us"
-        else:
-            self.serviceUrl = "https://login.microsoftonline.com"
-        self.securityTokenServicePath = "extSTS.srf"
-        self.userRealmServicePath = "GetUserRealm.srf"
-        self.tokenIssuer = "urn:federation:MicrosoftOnline"
-        self.created = datetime.now(tz=timezone.utc)
-        self.expires = self.created + timedelta(minutes=30)
-        self.signInPage = "_forms/default.aspx?wa=wsignin1.0"
-
-    def reset(self):
-        """Renew the expiration time."""
-        self.created = datetime.now(tz=timezone.utc)
-        self.expires = self.created + timedelta(minutes=30)
-
-    @property
-    def tenant(self):
-        return urlparse(self.authorityUrl).netloc
-
-    @property
-    def security_token_service_url(self):
-        return "/".join([self.serviceUrl, self.securityTokenServicePath])
-
-    @property
-    def signin_page_url(self):
-        return "/".join([self.authorityUrl, self.signInPage])
-
-    @property
-    def user_realm_service_url(self):
-        return "/".join([self.serviceUrl, self.userRealmServicePath])